13
0
livetrax/gtk2_ardour/sfdb_freesound_mootcher.h
Colin Fletcher 9fe0a4f4dd freesound: update to API v2
Add a new client id & token for Ardour 7, and update to Freesound's API
v2.

Implement OAuth authentication for Freesound downloads, as described at:
https://freesound.org/docs/api/authentication.html#oauth-authentication

Open the Freesound login page in the default browser, so that the user
can log in and get an authorization code, to copy-&-paste from the
browser. Exchange this authorization code for an access token, and use
it in a custom 'Authorization: Bearer $TOKEN' http header.

If logging in to Freesound to download a file fails or is cancelled,
clear the 'downloading' flag for that file in the list so that a
subsequent click on it will try to log in again.

Show login progress in download progress bar, and disable preview if
file hasn't yet been downloaded.

If a download fails for any reason (except the user cancelling it),
report an error in the Log window.

Use curl_free() for pointers returned by curl_easy_escape(), as per the
curl documentation, rather than plain free().

Also, don't use the www. sub-domain of freesound.org: although it
appears to work for most things, it returns an empty document from
https://freesound.org/apiv2/oauth2/access_token/

Remove default empty token value from Mootcher constructor, to make it
explicit when we construct a Mootcher that doesn't require
authorisation, by requiring an empty token parameter in that case.
2022-05-20 14:33:57 +01:00

135 lines
4.5 KiB
C++

/*
* Copyright (C) 2008-2015 Paul Davis <paul@linuxaudiosystems.com>
* Copyright (C) 2011-2012 Carl Hetherington <carl@carlh.net>
* Copyright (C) 2013 Colin Fletcher <colin.m.fletcher@googlemail.com>
* Copyright (C) 2015-2016 Tim Mayberry <mojofunk@gmail.com>
* Copyright (C) 2015-2019 Robin Gareus <robin@gareus.org>
*
* 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.
*/
/*sfdb_freesound_mootcher.h****************************************************************************
Adapted for Ardour by Ben Loftis, March 2008
Updated to new Freesound API by Colin Fletcher, November 2011
Mootcher Online Access to thefreesoundproject website
http://freesound.iua.upf.edu/
GPL 2005 Jorn Lemon
mail for questions/remarks: mootcher@twistedlemon.nl
or go to the freesound website forum
*****************************************************************************/
#ifndef __gtk_ardour_sfdb_freesound_mootcher_h__
#define __gtk_ardour_sfdb_freesound_mootcher_h__
#include <string>
#include <stdio.h>
#include <cstring>
#include <string>
#include <sstream>
#include <vector>
#include <gtkmm/progressbar.h>
//#include <ctime>
#include "sfdb_ui.h"
#include "curl/curl.h"
//--- struct to store XML file
struct SfdbMemoryStruct {
char *memory;
size_t size;
};
enum sortMethod {
sort_none, // no sort
sort_duration_descending, // Sort by the duration of the sounds, longest sounds first.
sort_duration_ascending, // Same as above, but shortest sounds first.
sort_created_descending, // Sort by the date of when the sound was added. newest sounds first.
sort_created_ascending, // Same as above, but oldest sounds first.
sort_downloads_descending, // Sort by the number of downloads, most downloaded sounds first.
sort_downloads_ascending, // Same as above, but least downloaded sounds first.
sort_rating_descending, // Sort by the average rating given to the sounds, highest rated first.
sort_rating_ascending // Same as above, but lowest rated sounds first.
};
class Mootcher: public sigc::trackable, public PBD::ScopedConnectionList
{
public:
Mootcher(const std::string &token);
~Mootcher();
bool checkAudioFile(std::string originalFileName, std::string ID);
bool fetchAudioFile(std::string originalFileName, std::string ID, std::string audioURL, SoundFileBrowser *caller, std::string &token);
std::string searchText(std::string query, int page, std::string filter, enum sortMethod sort);
std::string searchSimilar(std::string id);
void* threadFunc();
SoundFileBrowser *sfb;
std::string audioFileName;
std::string ID;
/** signal emitted when mootcher reports progress updates during download.
* The parameters are current and total numbers of bytes downloaded.
*/
PBD::Signal2<void, double, double> Progress;
/** signal emitted when the mootcher has finished downloading. */
PBD::Signal0<void> Finished;
private:
void ensureWorkingDir ();
bool get_oauth_token();
std::string auth_code_to_oauth_token(const std::string &auth_code);
std::string doRequest(std::string uri, std::string params);
void setcUrlOptions();
static size_t WriteMemoryCallback (void *ptr, size_t size, size_t nmemb, void *data);
static int progress_callback (void *clientp, double dltotal, double dlnow, double ultotal, double ulnow);
std::string sortMethodString (enum sortMethod sort);
std::string getSoundResourceFile (std::string ID);
CURL *curl;
char errorBuffer[CURL_ERROR_SIZE]; // storage for cUrl error message
FILE* theFile;
void updateProgress(double dlnow, double dltotal);
void doneWithMootcher();
void report_login_error(const std::string &msg);
Gtk::HBox progress_hbox;
Gtk::ProgressBar progress_bar;
Gtk::Button cancel_download_btn;
bool cancel_download;
void cancelDownload() {
cancel_download = true;
progress_hbox.hide();
}
std::string basePath;
std::string xmlLocation;
std::string oauth_token;
struct curl_slist *custom_headers;
};
#endif // __gtk_ardour_sfdb_freesound_mootcher_h__