src/lib/update_checker.cc

   1 /*
   2     Copyright (C) 2014-2015 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 #include "update_checker.h"
  22 #include "version.h"
  23 #include "util.h"
  24 #include <dcp/raw_convert.h>
  25 #include <libcxml/cxml.h>
  26 #include <curl/curl.h>
  27 #include <boost/algorithm/string.hpp>
  28 #include <string>
  29 #include <iostream>
  30
  31 #define BUFFER_SIZE 1024
  32
  33 using std::cout;
  34 using std::min;
  35 using std::string;
  36 using std::vector;
  37 using boost::is_any_of;
  38 using boost::ends_with;
  39 using dcp::raw_convert;
  40
  41 /** Singleton instance */
  42 UpdateChecker* UpdateChecker::_instance = 0;
  43
  44 static size_t
  45 write_callback_wrapper (void* data, size_t size, size_t nmemb, void* user)
  46 {
  47         return reinterpret_cast<UpdateChecker*>(user)->write_callback (data, size, nmemb);
  48 }
  49
  50 /** Construct an UpdateChecker.  This sets things up and starts a thread to
  51  *  do the work.
  52  */
  53 UpdateChecker::UpdateChecker ()
  54         : _buffer (new char[BUFFER_SIZE])
  55         , _offset (0)
  56         , _curl (0)
  57         , _state (NOT_RUN)
  58         , _emits (0)
  59         , _thread (0)
  60         , _to_do (0)
  61         , _terminate (false)
  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 void
  75 UpdateChecker::start ()
  76 {
  77         _thread = new boost::thread (boost::bind (&UpdateChecker::thread, this));
  78 #ifdef DCPOMATIC_LINUX
  79         pthread_setname_np (_thread->native_handle(), "update-checker");
  80 #endif
  81 }
  82
  83 UpdateChecker::~UpdateChecker ()
  84 {
  85         {
  86                 boost::mutex::scoped_lock lm (_process_mutex);
  87                 _terminate = true;
  88         }
  89
  90         _condition.notify_all ();
  91         if (_thread) {
  92                 /* Ideally this would be a DCPOMATIC_ASSERT(_thread->joinable()) but we
  93                    can't throw exceptions from a destructor.
  94                 */
  95                 if (_thread->joinable ()) {
  96                         _thread->join ();
  97                 }
  98         }
  99         delete _thread;
 100
 101         curl_easy_cleanup (_curl);
 102         delete[] _buffer;
 103 }
 104
 105 /** Start running the update check */
 106 void
 107 UpdateChecker::run ()
 108 {
 109         boost::mutex::scoped_lock lm (_process_mutex);
 110         _to_do++;
 111         _condition.notify_one ();
 112 }
 113
 114 void
 115 UpdateChecker::thread ()
 116 {
 117         while (true) {
 118                 /* Block until there is something to do */
 119                 boost::mutex::scoped_lock lock (_process_mutex);
 120                 while (_to_do == 0 && !_terminate) {
 121                         _condition.wait (lock);
 122                 }
 123
 124                 if (_terminate) {
 125                         return;
 126                 }
 127
 128                 --_to_do;
 129                 lock.unlock ();
 130
 131                 try {
 132                         _offset = 0;
 133
 134                         /* Perform the request */
 135
 136                         int r = curl_easy_perform (_curl);
 137                         if (r != CURLE_OK) {
 138                                 set_state (FAILED);
 139                                 return;
 140                         }
 141
 142                         /* Parse the reply */
 143
 144                         _buffer[_offset] = '\0';
 145                         string s (_buffer);
 146                         cxml::Document doc ("Update");
 147                         doc.read_string (s);
 148
 149                         /* Read the current stable and test version numbers */
 150
 151                         string stable;
 152                         string test;
 153
 154                         {
 155                                 boost::mutex::scoped_lock lm (_data_mutex);
 156                                 stable = doc.string_child ("Stable");
 157                                 test = doc.string_child ("Test");
 158                         }
 159
 160                         if (version_less_than (dcpomatic_version, stable)) {
 161                                 _stable = stable;
 162                         }
 163
 164                         if (!test.empty() && version_less_than (dcpomatic_version, test)) {
 165                                 _test = test;
 166                         }
 167
 168                         if (_stable || _test) {
 169                                 set_state (YES);
 170                         } else {
 171                                 set_state (NO);
 172                         }
 173                 } catch (...) {
 174                         set_state (FAILED);
 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 + _offset, data, t);
 184         _offset += t;
 185         return t;
 186 }
 187
 188 void
 189 UpdateChecker::set_state (State s)
 190 {
 191         {
 192                 boost::mutex::scoped_lock lm (_data_mutex);
 193                 _state = s;
 194                 _emits++;
 195         }
 196
 197         emit (boost::bind (boost::ref (StateChanged)));
 198 }
 199
 200 UpdateChecker *
 201 UpdateChecker::instance ()
 202 {
 203         if (!_instance) {
 204                 _instance = new UpdateChecker ();
 205                 _instance->start ();
 206         }
 207
 208         return _instance;
 209 }
 210
 211 bool
 212 UpdateChecker::version_less_than (string const & a, string const & b)
 213 {
 214         vector<string> ap;
 215         split (ap, a, is_any_of ("."));
 216         vector<string> bp;
 217         split (bp, b, is_any_of ("."));
 218
 219         DCPOMATIC_ASSERT (ap.size() == 3 && bp.size() == 3);
 220
 221         if (ap[0] != bp[0]) {
 222                 return raw_convert<int> (ap[0]) < raw_convert<int> (bp[0]);
 223         }
 224
 225         if (ap[1] != bp[1]) {
 226                 return raw_convert<int> (ap[1]) < raw_convert<int> (bp[1]);
 227         }
 228         float am;
 229         if (ends_with (ap[2], "devel")) {
 230                 am = raw_convert<int> (ap[2].substr (0, ap[2].length() - 5)) + 0.5;
 231         } else {
 232                 am = raw_convert<int> (ap[2]);
 233         }
 234
 235         float bm;
 236         if (ends_with (bp[2], "devel")) {
 237                 bm = raw_convert<int> (bp[2].substr (0, bp[2].length() - 5)) + 0.5;
 238         } else {
 239                 bm = raw_convert<int> (bp[2]);
 240         }
 241
 242         return am < bm;
 243 }