simgear/io/SVNRepository.cxx

   1 // DAVMirrorTree -- mirror a DAV tree to the local file-system
   2 //
   3 // Copyright (C) 2012  James Turner <zakalawe@mac.com>
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18
  19 #include "SVNRepository.hxx"
  20
  21 #include <iostream>
  22 #include <cstring>
  23 #include <cassert>
  24 #include <algorithm>
  25 #include <sstream>
  26 #include <map>
  27 #include <set>
  28 #include <fstream>
  29
  30 #include <boost/foreach.hpp>
  31
  32 #include "simgear/debug/logstream.hxx"
  33 #include "simgear/misc/strutils.hxx"
  34 #include <simgear/misc/sg_dir.hxx>
  35 #include <simgear/io/HTTPClient.hxx>
  36 #include <simgear/io/DAVMultiStatus.hxx>
  37 #include <simgear/io/SVNDirectory.hxx>
  38 #include <simgear/io/sg_file.hxx>
  39 #include <simgear/io/SVNReportParser.hxx>
  40
  41 using std::cout;
  42 using std::cerr;
  43 using std::endl;
  44 using std::string;
  45
  46 namespace simgear
  47 {
  48
  49 typedef std::vector<HTTP::Request_ptr> RequestVector;
  50
  51 class SVNRepoPrivate
  52 {
  53 public:
  54     SVNRepoPrivate(SVNRepository* parent) :
  55         p(parent),
  56         isUpdating(false),
  57         status(SVNRepository::SVN_NO_ERROR)
  58     { ; }
  59
  60     SVNRepository* p; // link back to outer
  61     SVNDirectory* rootCollection;
  62     HTTP::Client* http;
  63     std::string baseUrl;
  64     std::string vccUrl;
  65     std::string targetRevision;
  66     bool isUpdating;
  67     SVNRepository::ResultCode status;
  68
  69     void svnUpdateDone()
  70     {
  71         isUpdating = false;
  72     }
  73
  74     void updateFailed(HTTP::Request* req, SVNRepository::ResultCode err)
  75     {
  76         SG_LOG(SG_IO, SG_WARN, "SVN: failed to update from:" << req->url());
  77         isUpdating = false;
  78         status = err;
  79     }
  80
  81     void propFindComplete(HTTP::Request* req, DAVCollection* col);
  82     void propFindFailed(HTTP::Request* req, SVNRepository::ResultCode err);
  83 };
  84
  85
  86 namespace { // anonmouse
  87
  88     string makeAbsoluteUrl(const string& url, const string& base)
  89     {
  90       if (strutils::starts_with(url, "http://"))
  91         return url; // already absolute
  92
  93       assert(strutils::starts_with(base, "http://"));
  94       int schemeEnd = base.find("://");
  95       int hostEnd = base.find('/', schemeEnd + 3);
  96       if (hostEnd < 0) {
  97         return url;
  98       }
  99
 100       return base.substr(0, hostEnd) + url;
 101     }
 102
 103     // keep the responses small by only requesting the properties we actually
 104     // care about; the ETag, length and MD5-sum
 105     const char* PROPFIND_REQUEST_BODY =
 106       "<?xml version=\"1.0\" encoding=\"utf-8\" ?>"
 107       "<D:propfind xmlns:D=\"DAV:\">"
 108       "<D:prop xmlns:R=\"http://subversion.tigris.org/xmlns/dav/\">"
 109       "<D:resourcetype/>"
 110       "<D:version-name/>"
 111       "<D:version-controlled-configuration/>"
 112       "</D:prop>"
 113       "</D:propfind>";
 114
 115     class PropFindRequest : public HTTP::Request
 116     {
 117     public:
 118       PropFindRequest(SVNRepoPrivate* repo) :
 119         Request(repo->baseUrl, "PROPFIND"),
 120         _repo(repo)
 121       {
 122       }
 123
 124       virtual string_list requestHeaders() const
 125       {
 126         string_list r;
 127         r.push_back("Depth");
 128         return r;
 129       }
 130
 131       virtual string header(const string& name) const
 132       {
 133           if (name == "Depth") {
 134               return "0";
 135           }
 136
 137           return string();
 138       }
 139
 140       virtual string requestBodyType() const
 141       {
 142           return "application/xml; charset=\"utf-8\"";
 143       }
 144
 145       virtual int requestBodyLength() const
 146       {
 147         return strlen(PROPFIND_REQUEST_BODY);
 148       }
 149
 150       virtual int getBodyData(char* buf, int count) const
 151       {
 152         int bodyLen = strlen(PROPFIND_REQUEST_BODY);
 153         assert(count >= bodyLen);
 154         memcpy(buf, PROPFIND_REQUEST_BODY, bodyLen);
 155         return bodyLen;
 156       }
 157
 158     protected:
 159       virtual void responseHeadersComplete()
 160       {
 161         if (responseCode() == 207) {
 162             // fine
 163         } else if (responseCode() == 404) {
 164             _repo->propFindFailed(this, SVNRepository::SVN_ERROR_NOT_FOUND);
 165         } else {
 166             SG_LOG(SG_IO, SG_WARN, "request for:" << url() <<
 167                 " return code " << responseCode());
 168             _repo->propFindFailed(this, SVNRepository::SVN_ERROR_SOCKET);
 169         }
 170       }
 171
 172       virtual void responseComplete()
 173       {
 174         if (responseCode() == 207) {
 175           _davStatus.finishParse();
 176           _repo->propFindComplete(this, (DAVCollection*) _davStatus.resource());
 177         }
 178       }
 179
 180       virtual void gotBodyData(const char* s, int n)
 181       {
 182         if (responseCode() != 207) {
 183           return;
 184         }
 185         _davStatus.parseXML(s, n);
 186       }
 187     private:
 188       SVNRepoPrivate* _repo;
 189       DAVMultiStatus _davStatus;
 190     };
 191
 192 class UpdateReportRequest : public HTTP::Request
 193 {
 194 public:
 195   UpdateReportRequest(SVNRepoPrivate* repo,
 196       const std::string& aVersionName,
 197       bool startEmpty) :
 198     HTTP::Request("", "REPORT"),
 199     _requestSent(0),
 200     _parser(repo->p),
 201     _repo(repo),
 202     _failed(false)
 203   {
 204     setUrl(repo->vccUrl);
 205
 206     _request =
 207     "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n"
 208     "<S:update-report send-all=\"true\" xmlns:S=\"svn:\">\n"
 209     "<S:src-path>" + repo->baseUrl + "</S:src-path>\n"
 210     "<S:depth>unknown</S:depth>\n";
 211
 212     _request += "<S:entry rev=\"" + aVersionName + "\" depth=\"infinity\" start-empty=\"true\"/>\n";
 213
 214     if (!startEmpty) {
 215         string_list entries;
 216         _repo->rootCollection->mergeUpdateReportDetails(0, entries);
 217         BOOST_FOREACH(string e, entries) {
 218             _request += e + "\n";
 219         }
 220     }
 221
 222     _request += "</S:update-report>";
 223   }
 224
 225   virtual string requestBodyType() const
 226   {
 227     return "application/xml; charset=\"utf-8\"";
 228   }
 229
 230   virtual int requestBodyLength() const
 231   {
 232     return _request.size();
 233   }
 234
 235   virtual int getBodyData(char* buf, int count) const
 236   {
 237     int len = std::min(count, requestBodyLength() - _requestSent);
 238     memcpy(buf, _request.c_str() + _requestSent, len);
 239     _requestSent += len;
 240     return len;
 241   }
 242
 243 protected:
 244   virtual void responseHeadersComplete()
 245   {
 246
 247   }
 248
 249   virtual void responseComplete()
 250   {
 251       if (_failed) {
 252           return;
 253       }
 254
 255     if (responseCode() == 200) {
 256           SVNRepository::ResultCode err = _parser.finishParse();
 257           if (err) {
 258               _repo->updateFailed(this, err);
 259               _failed = true;
 260           } else {
 261               _repo->svnUpdateDone();
 262           }
 263     } else if (responseCode() == 404) {
 264         _repo->updateFailed(this, SVNRepository::SVN_ERROR_NOT_FOUND);
 265         _failed = true;
 266     } else {
 267         SG_LOG(SG_IO, SG_WARN, "SVN: request for:" << url() <<
 268         " return code " << responseCode());
 269         _repo->updateFailed(this, SVNRepository::SVN_ERROR_SOCKET);
 270         _failed = true;
 271     }
 272   }
 273
 274   virtual void gotBodyData(const char* s, int n)
 275   {
 276       if (_failed) {
 277           return;
 278       }
 279
 280     if (responseCode() != 200) {
 281         return;
 282     }
 283
 284     //cout << "body data:" << string(s, n) << endl;
 285     SVNRepository::ResultCode err = _parser.parseXML(s, n);
 286     if (err) {
 287         _failed = true;
 288         SG_LOG(SG_IO, SG_WARN, "SVN: request for:" << url() <<
 289             " XML parse failed");
 290         _repo->updateFailed(this, err);
 291     }
 292   }
 293
 294
 295 private:
 296   string _request;
 297   mutable int _requestSent;
 298   SVNReportParser _parser;
 299   SVNRepoPrivate* _repo;
 300   bool _failed;
 301 };
 302
 303 } // anonymous
 304
 305 SVNRepository::SVNRepository(const SGPath& base, HTTP::Client *cl) :
 306   _d(new SVNRepoPrivate(this))
 307 {
 308   _d->http = cl;
 309   _d->rootCollection = new SVNDirectory(this, base);
 310   _d->baseUrl = _d->rootCollection->url();
 311 }
 312
 313 SVNRepository::~SVNRepository()
 314 {
 315     delete _d->rootCollection;
 316 }
 317
 318 void SVNRepository::setBaseUrl(const std::string &url)
 319 {
 320   _d->baseUrl = url;
 321   _d->rootCollection->setBaseUrl(url);
 322 }
 323
 324 std::string SVNRepository::baseUrl() const
 325 {
 326   return _d->baseUrl;
 327 }
 328
 329 HTTP::Client* SVNRepository::http() const
 330 {
 331   return _d->http;
 332 }
 333
 334 SGPath SVNRepository::fsBase() const
 335 {
 336   return _d->rootCollection->fsPath();
 337 }
 338
 339 bool SVNRepository::isBare() const
 340 {
 341     if (!fsBase().exists() || Dir(fsBase()).isEmpty()) {
 342         return true;
 343     }
 344
 345     if (_d->vccUrl.empty()) {
 346         return true;
 347     }
 348
 349     return false;
 350 }
 351
 352 void SVNRepository::update()
 353 {
 354     _d->status = SVN_NO_ERROR;
 355     if (_d->targetRevision.empty() || _d->vccUrl.empty()) {
 356         _d->isUpdating = true;
 357         PropFindRequest* pfr = new PropFindRequest(_d.get());
 358         http()->makeRequest(pfr);
 359         return;
 360     }
 361
 362     if (_d->targetRevision == rootDir()->cachedRevision()) {
 363         SG_LOG(SG_IO, SG_DEBUG, baseUrl() << " in sync at version " << _d->targetRevision);
 364         _d->isUpdating = false;
 365         return;
 366     }
 367
 368     _d->isUpdating = true;
 369     UpdateReportRequest* urr = new UpdateReportRequest(_d.get(),
 370         _d->targetRevision, isBare());
 371     http()->makeRequest(urr);
 372 }
 373
 374 bool SVNRepository::isDoingSync() const
 375 {
 376     if (_d->status != SVN_NO_ERROR) {
 377         return false;
 378     }
 379
 380     return _d->isUpdating || _d->rootCollection->isDoingSync();
 381 }
 382
 383 SVNDirectory* SVNRepository::rootDir() const
 384 {
 385     return _d->rootCollection;
 386 }
 387
 388 SVNRepository::ResultCode
 389 SVNRepository::failure() const
 390 {
 391     return _d->status;
 392 }
 393
 394 ///////////////////////////////////////////////////////////////////////////
 395
 396 void SVNRepoPrivate::propFindComplete(HTTP::Request* req, DAVCollection* c)
 397 {
 398     targetRevision = c->versionName();
 399     vccUrl = makeAbsoluteUrl(c->versionControlledConfiguration(), baseUrl);
 400     rootCollection->collection()->setVersionControlledConfiguration(vccUrl);
 401     p->update();
 402 }
 403
 404 void SVNRepoPrivate::propFindFailed(HTTP::Request *req, SVNRepository::ResultCode err)
 405 {
 406     if (err != SVNRepository::SVN_ERROR_NOT_FOUND) {
 407         SG_LOG(SG_IO, SG_WARN, "PropFind failed for:" << req->url());
 408     }
 409
 410     isUpdating = false;
 411     status = err;
 412 }
 413
 414 } // of namespace simgear