ardour/livetrax
13
0
Fork 0
Code

libpbd: new threader Inflater and Downlaoder classes

Browse Source
This commit is contained in:
Paul Davis 2022-09-13 13:53:03 -06:00
parent 2061c3780d
commit 375daf4810
5 changed files with 386 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

185
libs/pbd/downloader.cc Normal file
View File

@ -0,0 +1,185 @@
/*
* Copyright (C) 2022 Paul Davis <paul@linuxaudiosystems.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include <glib/gstdio.h>
#include <glibmm/fileutils.h>
#include <glibmm/miscutils.h>
#include "pbd/downloader.h"
#include "pbd/error.h"
#include "pbd/i18n.h"
#include "pbd/pthread_utils.h"
using namespace PBD;
using std::string;
static size_t
CurlWrite_CallbackFunc_Downloader(void *contents, size_t size, size_t nmemb, Downloader* dl)
{
return dl->write (contents, size, nmemb);
}
size_t
Downloader::write (void *ptr, size_t size, size_t nmemb)
{
if (_cancel) {
fclose (file);
file = 0;
::g_unlink (file_path.c_str());
_downloaded = 0;
_download_size = 0;
return 0;
}
size_t nwritten = fwrite (ptr, size, nmemb, file);
_downloaded += nwritten;
return nwritten;
}
Downloader::Downloader (string const & u, string const & dir)
: url (u)
, destdir (dir)
, file (0)
, _cancel (false)
, _download_size (0)
, _downloaded (0)
{
}
Downloader::~Downloader ()
{
cleanup();
}
int
Downloader::start ()
{
file_path = Glib::build_filename (destdir, Glib::path_get_basename (url));
if (!(file = fopen (file_path.c_str(), "w"))) {
return -1;
}
_cancel = false;
_status = 0; /* unknown at this point */
thr = std::thread (&Downloader::download, this);
return 0;
}
void
Downloader::cleanup ()
{
thr.join ();
}
void
Downloader::cancel ()
{
_cancel = true;
}
double
Downloader::progress () const
{
if (_download_size == 0) {
return 0.;
}
return (double) _downloaded / _download_size;
}
void
Downloader::download ()
{
char curl_error[CURL_ERROR_SIZE];
{
/* First curl fetch to get the data size so that we can offer a
* progress meter
*/
curl = curl_easy_init ();
if (!curl) {
_status = -1;
return;
}
/* get size */
curl_easy_setopt (curl, CURLOPT_URL, url.c_str());
curl_easy_setopt(curl, CURLOPT_NOBODY, 1L);
curl_easy_setopt(curl, CURLOPT_HEADER, 0L);
curl_easy_setopt (curl, CURLOPT_FOLLOWLOCATION, 1L);
curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, curl_error);
CURLcode res = curl_easy_perform (curl);
if (res == CURLE_OK) {
double dsize;
curl_easy_getinfo (curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &dsize);
_download_size = dsize;
}
curl_easy_cleanup (curl);
if (res != CURLE_OK ) {
error << string_compose (_("Download failed, error code %1 (%2)"), curl_easy_strerror (res), curl_error) << endmsg;
_status = -2;
return;
}
}
curl = curl_easy_init ();
if (!curl) {
_status = -1;
return;
}
curl_easy_setopt (curl, CURLOPT_URL, url.c_str());
curl_easy_setopt (curl, CURLOPT_FOLLOWLOCATION, 1L);
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, CurlWrite_CallbackFunc_Downloader);
curl_easy_setopt(curl, CURLOPT_WRITEDATA, this);
CURLcode res = curl_easy_perform (curl);
curl_easy_cleanup (curl);
if (res == CURLE_OK) {
_status = 1;
} else {
_status = -1;
}
if (file) {
fclose (file);
file = 0;
}
}
std::string
Downloader::download_path() const
{
/* Can only return the download path if we completed, and completed successfully */
if (_status > 0) {
return file_path;
}
return std::string();
}

77
libs/pbd/inflater.cc Normal file
View File

@ -0,0 +1,77 @@
/*
* Copyright (C) 2022 Paul Davis <paul@linuxaudiosystems.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include <glib/gstdio.h>
#include <glibmm/fileutils.h>
#include <glibmm/miscutils.h>
#include "pbd/inflater.h"
#include "pbd/pthread_utils.h"
using namespace PBD;
Inflater::Inflater (std::string const & ap, std::string const & dd)
: FileArchive (ap)
, thread (0)
, _status (-1) /* means "unknown" */
, archive_path (ap)
, destdir (dd)
{
}
Inflater::~Inflater ()
{
if (thread) {
thread->join ();
}
}
int
Inflater::start ()
{
return 0 != (thread = PBD::Thread::create (boost::bind (&Inflater::threaded_inflate, this)));
}
void
Inflater::threaded_inflate ()
{
require_progress ();
try {
std::string pwd (Glib::get_current_dir ());
if (inflate (destdir)) {
/* cleanup ? */
_status = 1; /* failure */
}
_status = 0; /* success */
} catch (...) {
_status = 1; /* failure */
}
/* final progress signal, values do not matter much because status is
* set to be >= 0
*/
progress (1, 1);
}

68
libs/pbd/pbd/downloader.h Normal file
View File

@ -0,0 +1,68 @@
/*
* Copyright (C) 2022 Paul Davis <paul@linuxaudiosystems.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef __libpbd_downloader_h__
#define __libpbd_downloader_h__
#include <atomic>
#include <string>
#include <thread>
#include <curl/curl.h>
#include "pbd/libpbd_visibility.h"
namespace PBD {
class LIBPBD_API Downloader {
public:
Downloader (std::string const & url, std::string const & destdir);
~Downloader ();
int start ();
void cleanup ();
void cancel ();
double progress() const;
uint64_t download_size() const { return _download_size; }
uint64_t downloaded () const { return _downloaded; }
/* public so it can be called from a static C function */
size_t write (void *contents, size_t size, size_t nmemb);
int status() const { return _status; }
std::string download_path() const;
private:
std::string url;
std::string destdir;
std::string file_path;
FILE* file;
CURL* curl;
bool _cancel;
std::atomic<uint64_t> _download_size; /* read-only from requestor thread */
std::atomic<uint64_t> _downloaded; /* read-only from requestor thread */
std::atomic<int> _status;
std::thread thr;
void download ();
};
} /* namespace */
#endif

54
libs/pbd/pbd/inflater.h Normal file
View File

@ -0,0 +1,54 @@
/*
* Copyright (C) 2022 Paul Davis <paul@linuxaudiosystems.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef __libpbd_inflater_h__
#define __libpbd_inflater_h__
#include <string>
#include "pbd/file_archive.h"
#include "pbd/libpbd_visibility.h"
namespace PBD {
class Thread;
}
namespace PBD {
class LIBPBD_API Inflater : public PBD::FileArchive
{
public:
Inflater (std::string const & archive_path, std::string const & destdir);
~Inflater ();
int start ();
bool running() const { return thread != 0; }
int status() const { return _status; }
private:
PBD::Thread* thread;
int _status;
std::string archive_path;
std::string destdir;
void threaded_inflate ();
};
} /* namespace */
#endif

2
libs/pbd/wscript
View File

@ -42,6 +42,7 @@ libpbd_sources = [
'cpus.cc',
'debug.cc',
'demangle.cc',
'downloader.cc',
'enumwriter.cc',
'event_loop.cc',
'enums.cc',
@ -53,6 +54,7 @@ libpbd_sources = [
'fpu.cc',
'glib_event_source.cc',
'id.cc',
'inflater.cc',
'locale_guard.cc',
'localtime_r.cc',
'malign.cc',