fdroidserver/checkupdates.py

   1 #!/usr/bin/env python2
   2 # -*- coding: utf-8 -*-
   3 #
   4 # checkupdates.py - part of the FDroid server tools
   5 # Copyright (C) 2010-13, Ciaran Gultnieks, ciaran@ciarang.com
   6 # Copyright (C) 2013-2014 Daniel Martí <mvdan@mvdan.cc>
   7 #
   8 # This program is free software: you can redistribute it and/or modify
   9 # it under the terms of the GNU Affero General Public License as published by
  10 # the Free Software Foundation, either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU Affero General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU Affero General Public License
  19 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 import sys
  22 import os
  23 import re
  24 import urllib2
  25 import time
  26 import subprocess
  27 from optparse import OptionParser
  28 import traceback
  29 import HTMLParser
  30 from distutils.version import LooseVersion
  31 import logging
  32
  33 import common
  34 import metadata
  35 from common import VCSException
  36 from metadata import MetaDataException
  37
  38
  39 # Check for a new version by looking at a document retrieved via HTTP.
  40 # The app's Update Check Data field is used to provide the information
  41 # required.
  42 def check_http(app):
  43
  44     try:
  45
  46         if 'Update Check Data' not in app:
  47             raise Exception('Missing Update Check Data')
  48
  49         urlcode, codeex, urlver, verex = app['Update Check Data'].split('|')
  50
  51         vercode = "99999999"
  52         if len(urlcode) > 0:
  53             logging.debug("...requesting {0}".format(urlcode))
  54             req = urllib2.Request(urlcode, None)
  55             resp = urllib2.urlopen(req, None, 20)
  56             page = resp.read()
  57
  58             m = re.search(codeex, page)
  59             if not m:
  60                 raise Exception("No RE match for version code")
  61             vercode = m.group(1)
  62
  63         version = "??"
  64         if len(urlver) > 0:
  65             if urlver != '.':
  66                 logging.debug("...requesting {0}".format(urlver))
  67                 req = urllib2.Request(urlver, None)
  68                 resp = urllib2.urlopen(req, None, 20)
  69                 page = resp.read()
  70
  71             m = re.search(verex, page)
  72             if not m:
  73                 raise Exception("No RE match for version")
  74             version = m.group(1)
  75
  76         return (version, vercode)
  77
  78     except Exception:
  79         msg = "Could not complete http check for app {0} due to unknown error: {1}".format(app['id'], traceback.format_exc())
  80         return (None, msg)
  81
  82
  83 # Check for a new version by looking at the tags in the source repo.
  84 # Whether this can be used reliably or not depends on
  85 # the development procedures used by the project's developers. Use it with
  86 # caution, because it's inappropriate for many projects.
  87 # Returns (None, "a message") if this didn't work, or (version, vercode) for
  88 # the details of the current version.
  89 def check_tags(app, pattern):
  90
  91     try:
  92
  93         appid = app['Update Check Name'] or app['id']
  94         if app['Repo Type'] == 'srclib':
  95             build_dir = os.path.join('build', 'srclib', app['Repo'])
  96             repotype = common.getsrclibvcs(app['Repo'])
  97         else:
  98             build_dir = os.path.join('build/', app['id'])
  99             repotype = app['Repo Type']
 100
 101         if repotype not in ('git', 'git-svn', 'hg', 'bzr'):
 102             return (None, 'Tags update mode only works for git, hg, bzr and git-svn repositories currently', None)
 103
 104         if repotype == 'git-svn' and ';' not in app['Repo']:
 105             return (None, 'Tags update mode used in git-svn, but the repo was not set up with tags', None)
 106
 107         # Set up vcs interface and make sure we have the latest code...
 108         vcs = common.getvcs(app['Repo Type'], app['Repo'], build_dir)
 109
 110         vcs.gotorevision(None)
 111
 112         flavour = None
 113         if len(app['builds']) > 0:
 114             if app['builds'][-1]['subdir']:
 115                 build_dir = os.path.join(build_dir, app['builds'][-1]['subdir'])
 116             if app['builds'][-1]['gradle']:
 117                 flavour = app['builds'][-1]['gradle']
 118         if flavour == 'yes':
 119             flavour = None
 120
 121         hpak = None
 122         htag = None
 123         hver = None
 124         hcode = "0"
 125
 126         tags = vcs.gettags()
 127         if pattern:
 128             pat = re.compile(pattern)
 129             tags = [tag for tag in tags if pat.match(tag)]
 130
 131         if repotype in ('git',):
 132             tags = vcs.latesttags(tags, 5)
 133
 134         for tag in tags:
 135             logging.debug("Check tag: '{0}'".format(tag))
 136             vcs.gotorevision(tag)
 137
 138             # Only process tags where the manifest exists...
 139             paths = common.manifest_paths(build_dir, flavour)
 140             version, vercode, package = \
 141                 common.parse_androidmanifests(paths, app['Update Check Ignore'])
 142             if not package or package != appid or not version or not vercode:
 143                 continue
 144
 145             logging.debug("Manifest exists. Found version {0} ({1})"
 146                           .format(version, vercode))
 147             if int(vercode) > int(hcode):
 148                 hpak = package
 149                 htag = tag
 150                 hcode = str(int(vercode))
 151                 hver = version
 152
 153         if not hpak:
 154             return (None, "Couldn't find package ID", None)
 155         if hver:
 156             return (hver, hcode, htag)
 157         return (None, "Couldn't find any version information", None)
 158
 159     except VCSException as vcse:
 160         msg = "VCS error while scanning app {0}: {1}".format(app['id'], vcse)
 161         return (None, msg, None)
 162     except Exception:
 163         msg = "Could not scan app {0} due to unknown error: {1}".format(app['id'], traceback.format_exc())
 164         return (None, msg, None)
 165
 166
 167 # Check for a new version by looking at the AndroidManifest.xml at the HEAD
 168 # of the source repo. Whether this can be used reliably or not depends on
 169 # the development procedures used by the project's developers. Use it with
 170 # caution, because it's inappropriate for many projects.
 171 # Returns (None, "a message") if this didn't work, or (version, vercode) for
 172 # the details of the current version.
 173 def check_repomanifest(app, branch=None):
 174
 175     try:
 176
 177         appid = app['Update Check Name'] or app['id']
 178         if app['Repo Type'] == 'srclib':
 179             build_dir = os.path.join('build', 'srclib', app['Repo'])
 180             repotype = common.getsrclibvcs(app['Repo'])
 181         else:
 182             build_dir = os.path.join('build/', app['id'])
 183             repotype = app['Repo Type']
 184
 185         # Set up vcs interface and make sure we have the latest code...
 186         vcs = common.getvcs(app['Repo Type'], app['Repo'], build_dir)
 187
 188         if repotype == 'git':
 189             if branch:
 190                 branch = 'origin/' + branch
 191             vcs.gotorevision(branch)
 192         elif repotype == 'git-svn':
 193             vcs.gotorevision(branch)
 194         elif repotype == 'svn':
 195             vcs.gotorevision(None)
 196         elif repotype == 'hg':
 197             vcs.gotorevision(branch)
 198         elif repotype == 'bzr':
 199             vcs.gotorevision(None)
 200
 201         flavour = None
 202
 203         if len(app['builds']) > 0:
 204             if app['builds'][-1]['subdir']:
 205                 build_dir = os.path.join(build_dir, app['builds'][-1]['subdir'])
 206             if app['builds'][-1]['gradle']:
 207                 flavour = app['builds'][-1]['gradle']
 208         if flavour == 'yes':
 209             flavour = None
 210
 211         if not os.path.isdir(build_dir):
 212             return (None, "Subdir '" + app['builds'][-1]['subdir'] + "'is not a valid directory")
 213
 214         paths = common.manifest_paths(build_dir, flavour)
 215
 216         version, vercode, package = \
 217             common.parse_androidmanifests(paths, app['Update Check Ignore'])
 218         if not package:
 219             return (None, "Couldn't find package ID")
 220         if package != appid:
 221             return (None, "Package ID mismatch")
 222         if not version:
 223             return (None, "Couldn't find latest version name")
 224         if not vercode:
 225             if "Ignore" == version:
 226                 return (None, "Latest version is ignored")
 227             return (None, "Couldn't find latest version code")
 228
 229         vercode = str(int(vercode))
 230
 231         logging.debug("Manifest exists. Found version {0} ({1})".format(version, vercode))
 232
 233         return (version, vercode)
 234
 235     except VCSException as vcse:
 236         msg = "VCS error while scanning app {0}: {1}".format(app['id'], vcse)
 237         return (None, msg)
 238     except Exception:
 239         msg = "Could not scan app {0} due to unknown error: {1}".format(app['id'], traceback.format_exc())
 240         return (None, msg)
 241
 242
 243 def check_repotrunk(app, branch=None):
 244
 245     try:
 246         if app['Repo Type'] == 'srclib':
 247             build_dir = os.path.join('build', 'srclib', app['Repo'])
 248             repotype = common.getsrclibvcs(app['Repo'])
 249         else:
 250             build_dir = os.path.join('build/', app['id'])
 251             repotype = app['Repo Type']
 252
 253         if repotype not in ('svn', 'git-svn'):
 254             return (None, 'RepoTrunk update mode only makes sense in svn and git-svn repositories')
 255
 256         # Set up vcs interface and make sure we have the latest code...
 257         vcs = common.getvcs(app['Repo Type'], app['Repo'], build_dir)
 258
 259         vcs.gotorevision(None)
 260
 261         ref = vcs.getref()
 262         return (ref, ref)
 263     except VCSException as vcse:
 264         msg = "VCS error while scanning app {0}: {1}".format(app['id'], vcse)
 265         return (None, msg)
 266     except Exception:
 267         msg = "Could not scan app {0} due to unknown error: {1}".format(app['id'], traceback.format_exc())
 268         return (None, msg)
 269
 270
 271 # Check for a new version by looking at the Google Play Store.
 272 # Returns (None, "a message") if this didn't work, or (version, None) for
 273 # the details of the current version.
 274 def check_gplay(app):
 275     time.sleep(15)
 276     url = 'https://play.google.com/store/apps/details?id=' + app['id']
 277     headers = {'User-Agent': 'Mozilla/5.0 (X11; Linux i686; rv:18.0) Gecko/20100101 Firefox/18.0'}
 278     req = urllib2.Request(url, None, headers)
 279     try:
 280         resp = urllib2.urlopen(req, None, 20)
 281         page = resp.read()
 282     except urllib2.HTTPError, e:
 283         return (None, str(e.code))
 284     except Exception, e:
 285         return (None, 'Failed:' + str(e))
 286
 287     version = None
 288
 289     m = re.search('itemprop="softwareVersion">[ ]*([^<]+)[ ]*</div>', page)
 290     if m:
 291         html_parser = HTMLParser.HTMLParser()
 292         version = html_parser.unescape(m.group(1))
 293
 294     if version == 'Varies with device':
 295         return (None, 'Device-variable version, cannot use this method')
 296
 297     if not version:
 298         return (None, "Couldn't find version")
 299     return (version.strip(), None)
 300
 301
 302 # Return all directories under startdir that contain any of the manifest
 303 # files, and thus are probably an Android project.
 304 def dirs_with_manifest(startdir):
 305     for r, d, f in os.walk(startdir):
 306         if any(m in f for m in [
 307                 'AndroidManifest.xml', 'pom.xml', 'build.gradle']):
 308             yield r
 309
 310
 311 # Tries to find a new subdir starting from the root build_dir. Returns said
 312 # subdir relative to the build dir if found, None otherwise.
 313 def check_changed_subdir(app):
 314
 315     appid = app['Update Check Name'] or app['id']
 316     if app['Repo Type'] == 'srclib':
 317         build_dir = os.path.join('build', 'srclib', app['Repo'])
 318     else:
 319         build_dir = os.path.join('build/', app['id'])
 320
 321     if not os.path.isdir(build_dir):
 322         return None
 323
 324     flavour = None
 325     if len(app['builds']) > 0 and app['builds'][-1]['gradle']:
 326         flavour = app['builds'][-1]['gradle']
 327     if flavour == 'yes':
 328         flavour = None
 329
 330     for d in dirs_with_manifest(build_dir):
 331         logging.debug("Trying possible dir %s." % d)
 332         m_paths = common.manifest_paths(d, flavour)
 333         package = common.parse_androidmanifests(m_paths, app['Update Check Ignore'])[2]
 334         if package and package == appid:
 335             logging.debug("Manifest exists in possible dir %s." % d)
 336             return os.path.relpath(d, build_dir)
 337
 338     return None
 339
 340
 341 def fetch_autoname(app, tag):
 342
 343     if not app["Repo Type"] or app['Update Check Mode'] in ('None', 'Static'):
 344         return None
 345
 346     if app['Repo Type'] == 'srclib':
 347         app_dir = os.path.join('build', 'srclib', app['Repo'])
 348     else:
 349         app_dir = os.path.join('build/', app['id'])
 350
 351     try:
 352         vcs = common.getvcs(app["Repo Type"], app["Repo"], app_dir)
 353         vcs.gotorevision(tag)
 354     except VCSException:
 355         return None
 356
 357     flavour = None
 358     if len(app['builds']) > 0:
 359         if app['builds'][-1]['subdir']:
 360             app_dir = os.path.join(app_dir, app['builds'][-1]['subdir'])
 361         if app['builds'][-1]['gradle']:
 362             flavour = app['builds'][-1]['gradle']
 363     if flavour == 'yes':
 364         flavour = None
 365
 366     logging.debug("...fetch auto name from " + app_dir +
 367                   ((" (flavour: %s)" % flavour) if flavour else ""))
 368     new_name = common.fetch_real_name(app_dir, flavour)
 369     commitmsg = None
 370     if new_name:
 371         logging.debug("...got autoname '" + new_name + "'")
 372         if new_name != app['Auto Name']:
 373             app['Auto Name'] = new_name
 374             if not commitmsg:
 375                 commitmsg = "Set autoname of {0}".format(common.getappname(app))
 376     else:
 377         logging.debug("...couldn't get autoname")
 378
 379     if app['Current Version'].startswith('@string/'):
 380         cv = common.version_name(app['Current Version'], app_dir, flavour)
 381         if app['Current Version'] != cv:
 382             app['Current Version'] = cv
 383             if not commitmsg:
 384                 commitmsg = "Fix CV of {0}".format(common.getappname(app))
 385
 386     return commitmsg
 387
 388
 389 def checkupdates_app(app, first=True):
 390
 391     # If a change is made, commitmsg should be set to a description of it.
 392     # Only if this is set will changes be written back to the metadata.
 393     commitmsg = None
 394
 395     tag = None
 396     msg = None
 397     vercode = None
 398     noverok = False
 399     mode = app['Update Check Mode']
 400     if mode.startswith('Tags'):
 401         pattern = mode[5:] if len(mode) > 4 else None
 402         (version, vercode, tag) = check_tags(app, pattern)
 403         msg = vercode
 404     elif mode == 'RepoManifest':
 405         (version, vercode) = check_repomanifest(app)
 406         msg = vercode
 407     elif mode.startswith('RepoManifest/'):
 408         tag = mode[13:]
 409         (version, vercode) = check_repomanifest(app, tag)
 410         msg = vercode
 411     elif mode == 'RepoTrunk':
 412         (version, vercode) = check_repotrunk(app)
 413         msg = vercode
 414     elif mode == 'HTTP':
 415         (version, vercode) = check_http(app)
 416         msg = vercode
 417     elif mode in ('None', 'Static'):
 418         version = None
 419         msg = 'Checking disabled'
 420         noverok = True
 421     else:
 422         version = None
 423         msg = 'Invalid update check method'
 424
 425     if first and version is None and vercode == "Couldn't find package ID":
 426         logging.warn("Couldn't find any version information. Looking for a subdir change...")
 427         new_subdir = check_changed_subdir(app)
 428         if new_subdir is None:
 429             logging.warn("Couldn't find any new subdir.")
 430         else:
 431             logging.warn("Trying a new subdir: %s" % new_subdir)
 432             new_build = {}
 433             metadata.fill_build_defaults(new_build)
 434             new_build['version'] = "Ignore"
 435             new_build['vercode'] = "-1"
 436             new_build['subdir'] = new_subdir
 437             app['builds'].append(new_build)
 438             return checkupdates_app(app, first=False)
 439
 440     if version and vercode and app['Vercode Operation']:
 441         op = app['Vercode Operation'].replace("%c", str(int(vercode)))
 442         vercode = str(eval(op))
 443
 444     updating = False
 445     if version is None:
 446         logmsg = "...{0} : {1}".format(app['id'], msg)
 447         if noverok:
 448             logging.info(logmsg)
 449         else:
 450             logging.warn(logmsg)
 451     elif vercode == app['Current Version Code']:
 452         logging.info("...up to date")
 453     else:
 454         app['Current Version'] = version
 455         app['Current Version Code'] = str(int(vercode))
 456         updating = True
 457
 458     commitmsg = fetch_autoname(app, tag)
 459
 460     if updating:
 461         name = common.getappname(app)
 462         ver = common.getcvname(app)
 463         logging.info('...updating to version %s' % ver)
 464         commitmsg = 'Update CV of %s to %s' % (name, ver)
 465
 466     if options.auto:
 467         mode = app['Auto Update Mode']
 468         if mode in ('None', 'Static'):
 469             pass
 470         elif mode.startswith('Version '):
 471             pattern = mode[8:]
 472             if pattern.startswith('+'):
 473                 try:
 474                     suffix, pattern = pattern.split(' ', 1)
 475                 except ValueError:
 476                     raise MetaDataException("Invalid AUM: " + mode)
 477             else:
 478                 suffix = ''
 479             gotcur = False
 480             latest = None
 481             for build in app['builds']:
 482                 if build['vercode'] == app['Current Version Code']:
 483                     gotcur = True
 484                 if not latest or int(build['vercode']) > int(latest['vercode']):
 485                     latest = build
 486
 487             if not gotcur:
 488                 newbuild = latest.copy()
 489                 if 'origlines' in newbuild:
 490                     del newbuild['origlines']
 491                 newbuild['disable'] = False
 492                 newbuild['vercode'] = app['Current Version Code']
 493                 newbuild['version'] = app['Current Version'] + suffix
 494                 logging.info("...auto-generating build for " + newbuild['version'])
 495                 commit = pattern.replace('%v', newbuild['version'])
 496                 commit = commit.replace('%c', newbuild['vercode'])
 497                 newbuild['commit'] = commit
 498                 app['builds'].append(newbuild)
 499                 name = common.getappname(app)
 500                 ver = common.getcvname(app)
 501                 commitmsg = "Update %s to %s" % (name, ver)
 502         else:
 503             logging.warn('Invalid auto update mode "' + mode + '" on ' + app['id'])
 504
 505     if commitmsg:
 506         metafile = os.path.join('metadata', app['id'] + '.txt')
 507         metadata.write_metadata(metafile, app)
 508         if options.commit:
 509             logging.info("Commiting update for " + metafile)
 510             gitcmd = ["git", "commit", "-m", commitmsg]
 511             if 'auto_author' in config:
 512                 gitcmd.extend(['--author', config['auto_author']])
 513             gitcmd.extend(["--", metafile])
 514             if subprocess.call(gitcmd) != 0:
 515                 logging.error("Git commit failed")
 516                 sys.exit(1)
 517
 518
 519 config = None
 520 options = None
 521
 522
 523 def main():
 524
 525     global config, options
 526
 527     # Parse command line...
 528     parser = OptionParser(usage="Usage: %prog [options] [APPID [APPID ...]]")
 529     parser.add_option("-v", "--verbose", action="store_true", default=False,
 530                       help="Spew out even more information than normal")
 531     parser.add_option("-q", "--quiet", action="store_true", default=False,
 532                       help="Restrict output to warnings and errors")
 533     parser.add_option("--auto", action="store_true", default=False,
 534                       help="Process auto-updates")
 535     parser.add_option("--autoonly", action="store_true", default=False,
 536                       help="Only process apps with auto-updates")
 537     parser.add_option("--commit", action="store_true", default=False,
 538                       help="Commit changes")
 539     parser.add_option("--gplay", action="store_true", default=False,
 540                       help="Only print differences with the Play Store")
 541     (options, args) = parser.parse_args()
 542
 543     config = common.read_config(options)
 544
 545     # Get all apps...
 546     allapps = metadata.read_metadata()
 547
 548     apps = common.read_app_args(args, allapps, False)
 549
 550     if options.gplay:
 551         for app in apps:
 552             version, reason = check_gplay(app)
 553             if version is None:
 554                 if reason == '404':
 555                     logging.info("{0} is not in the Play Store".format(common.getappname(app)))
 556                 else:
 557                     logging.info("{0} encountered a problem: {1}".format(common.getappname(app), reason))
 558             if version is not None:
 559                 stored = app['Current Version']
 560                 if not stored:
 561                     logging.info("{0} has no Current Version but has version {1} on the Play Store"
 562                                  .format(common.getappname(app), version))
 563                 elif LooseVersion(stored) < LooseVersion(version):
 564                     logging.info("{0} has version {1} on the Play Store, which is bigger than {2}"
 565                                  .format(common.getappname(app), version, stored))
 566                 else:
 567                     if stored != version:
 568                         logging.info("{0} has version {1} on the Play Store, which differs from {2}"
 569                                      .format(common.getappname(app), version, stored))
 570                     else:
 571                         logging.info("{0} has the same version {1} on the Play Store"
 572                                      .format(common.getappname(app), version))
 573         return
 574
 575     for app in apps:
 576
 577         if options.autoonly and app['Auto Update Mode'] in ('None', 'Static'):
 578             logging.debug("Nothing to do for {0}...".format(app['id']))
 579             continue
 580
 581         logging.info("Processing " + app['id'] + '...')
 582
 583         checkupdates_app(app)
 584
 585     logging.info("Finished.")
 586
 587 if __name__ == "__main__":
 588     main()