src/lib/update_checker.cc

   1 /*
   2     Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #include "update_checker.h"
  23 #include "version.h"
  24 #include "util.h"
  25 #include <dcp/raw_convert.h>
  26 #include <libcxml/cxml.h>
  27 #include <curl/curl.h>
  28 #include <boost/algorithm/string.hpp>
  29 #include <string>
  30 #include <iostream>
  31
  32
  33 #define BUFFER_SIZE 1024
  34
  35
  36 using std::cout;
  37 using std::min;
  38 using std::string;
  39 using std::vector;
  40 using boost::is_any_of;
  41 using boost::ends_with;
  42 using dcp::raw_convert;
  43
  44
  45 /** Singleton instance */
  46 UpdateChecker* UpdateChecker::_instance = nullptr;
  47
  48
  49 static size_t
  50 write_callback_wrapper (void* data, size_t size, size_t nmemb, void* user)
  51 {
  52         return reinterpret_cast<UpdateChecker*>(user)->write_callback (data, size, nmemb);
  53 }
  54
  55
  56 /** Construct an UpdateChecker.  This sets things up and starts a thread to
  57  *  do the work.
  58  */
  59 UpdateChecker::UpdateChecker ()
  60         : _buffer (BUFFER_SIZE)
  61         , _state (State::NOT_RUN)
  62 {
  63         _curl = curl_easy_init ();
  64
  65         curl_easy_setopt (_curl, CURLOPT_URL, "https://dcpomatic.com/update");
  66         curl_easy_setopt (_curl, CURLOPT_WRITEFUNCTION, write_callback_wrapper);
  67         curl_easy_setopt (_curl, CURLOPT_WRITEDATA, this);
  68         curl_easy_setopt (_curl, CURLOPT_TIMEOUT, 20);
  69
  70         string const agent = "dcpomatic/" + string (dcpomatic_version);
  71         curl_easy_setopt (_curl, CURLOPT_USERAGENT, agent.c_str ());
  72 }
  73
  74
  75 void
  76 UpdateChecker::start ()
  77 {
  78         _thread = boost::thread (boost::bind (&UpdateChecker::thread, this));
  79 #ifdef DCPOMATIC_LINUX
  80         pthread_setname_np (_thread.native_handle(), "update-checker");
  81 #endif
  82 }
  83
  84
  85 UpdateChecker::~UpdateChecker ()
  86 {
  87         boost::this_thread::disable_interruption dis;
  88
  89         {
  90                 boost::mutex::scoped_lock lm (_process_mutex);
  91                 _terminate = true;
  92         }
  93
  94         _condition.notify_all ();
  95         try {
  96                 _thread.join ();
  97         } catch (...) {}
  98
  99         curl_easy_cleanup (_curl);
 100 }
 101
 102
 103 /** Start running the update check */
 104 void
 105 UpdateChecker::run ()
 106 {
 107         boost::mutex::scoped_lock lm (_process_mutex);
 108         _to_do++;
 109         _condition.notify_one ();
 110 }
 111
 112
 113 void
 114 UpdateChecker::thread ()
 115 {
 116         while (true) {
 117                 /* Block until there is something to do */
 118                 boost::mutex::scoped_lock lock (_process_mutex);
 119                 while (_to_do == 0 && !_terminate) {
 120                         _condition.wait (lock);
 121                 }
 122
 123                 if (_terminate) {
 124                         return;
 125                 }
 126
 127                 --_to_do;
 128                 lock.unlock ();
 129
 130                 try {
 131                         _offset = 0;
 132
 133                         /* Perform the request */
 134
 135                         int r = curl_easy_perform (_curl);
 136                         if (r != CURLE_OK) {
 137                                 set_state (State::FAILED);
 138                                 continue;
 139                         }
 140
 141                         /* Parse the reply */
 142
 143                         _buffer[_offset] = '\0';
 144                         string s (_buffer.data());
 145                         cxml::Document doc ("Update");
 146                         doc.read_string (s);
 147
 148                         /* Read the current stable and test version numbers */
 149
 150                         string stable;
 151                         string test;
 152
 153                         {
 154                                 boost::mutex::scoped_lock lm (_data_mutex);
 155                                 stable = doc.string_child ("Stable");
 156                                 test = doc.string_child ("Test");
 157                         }
 158
 159                         if (version_less_than (dcpomatic_version, stable)) {
 160                                 _stable = stable;
 161                         }
 162
 163                         if (!test.empty() && version_less_than (dcpomatic_version, test)) {
 164                                 _test = test;
 165                         }
 166
 167                         if (_stable || _test) {
 168                                 set_state (State::YES);
 169                         } else {
 170                                 set_state (State::NO);
 171                         }
 172                 } catch (...) {
 173                         set_state (State::FAILED);
 174                 }
 175         }
 176 }
 177
 178
 179 size_t
 180 UpdateChecker::write_callback (void* data, size_t size, size_t nmemb)
 181 {
 182         size_t const t = min (size * nmemb, size_t (BUFFER_SIZE - _offset - 1));
 183         memcpy (_buffer.data() + _offset, data, t);
 184         _offset += t;
 185         return t;
 186 }
 187
 188
 189 void
 190 UpdateChecker::set_state (State s)
 191 {
 192         {
 193                 boost::mutex::scoped_lock lm (_data_mutex);
 194                 _state = s;
 195         }
 196
 197         emit (boost::bind(boost::ref(StateChanged)));
 198 }
 199
 200
 201 UpdateChecker *
 202 UpdateChecker::instance ()
 203 {
 204         if (!_instance) {
 205                 _instance = new UpdateChecker ();
 206                 _instance->start ();
 207         }
 208
 209         return _instance;
 210 }
 211
 212
 213 bool
 214 UpdateChecker::version_less_than (string const & a, string const & b)
 215 {
 216         vector<string> ap;
 217         split (ap, a, is_any_of ("."));
 218         vector<string> bp;
 219         split (bp, b, is_any_of ("."));
 220
 221         DCPOMATIC_ASSERT (ap.size() == 3 && bp.size() == 3);
 222
 223         if (ap[0] != bp[0]) {
 224                 return raw_convert<int>(ap[0]) < raw_convert<int>(bp[0]);
 225         }
 226
 227         if (ap[1] != bp[1]) {
 228                 return raw_convert<int>(ap[1]) < raw_convert<int>(bp[1]);
 229         }
 230         float am;
 231         if (ends_with (ap[2], "devel")) {
 232                 am = raw_convert<int>(ap[2].substr(0, ap[2].length() - 5)) + 0.5;
 233         } else {
 234                 am = raw_convert<int>(ap[2]);
 235         }
 236
 237         float bm;
 238         if (ends_with (bp[2], "devel")) {
 239                 bm = raw_convert<int>(bp[2].substr(0, bp[2].length() - 5)) + 0.5;
 240         } else {
 241                 bm = raw_convert<int>(bp[2]);
 242         }
 243
 244         return am < bm;
 245 }