2 # -*- coding: utf-8 -*-
4 # checkupdates.py - part of the FDroid server tools
5 # Copyright (C) 2010-2015, Ciaran Gultnieks, ciaran@ciarang.com
6 # Copyright (C) 2013-2014 Daniel Martà <mvdan@mvdan.cc>
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.
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.
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/>.
27 from optparse import OptionParser
30 from distutils.version import LooseVersion
35 from common import VCSException, FDroidException
36 from metadata import MetaDataException
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
46 if 'Update Check Data' not in app:
47 raise FDroidException('Missing Update Check Data')
49 urlcode, codeex, urlver, verex = app['Update Check Data'].split('|')
53 logging.debug("...requesting {0}".format(urlcode))
54 req = urllib2.Request(urlcode, None)
55 resp = urllib2.urlopen(req, None, 20)
58 m = re.search(codeex, page)
60 raise FDroidException("No RE match for version code")
66 logging.debug("...requesting {0}".format(urlver))
67 req = urllib2.Request(urlver, None)
68 resp = urllib2.urlopen(req, None, 20)
71 m = re.search(verex, page)
73 raise FDroidException("No RE match for version")
76 return (version, vercode)
78 except FDroidException:
79 msg = "Could not complete http check for app {0} due to unknown error: {1}".format(app['id'], traceback.format_exc())
83 def app_matches_packagename(app, package):
86 appid = app['Update Check Name'] or app['id']
89 return appid == package
92 # Check for a new version by looking at the tags in the source repo.
93 # Whether this can be used reliably or not depends on
94 # the development procedures used by the project's developers. Use it with
95 # caution, because it's inappropriate for many projects.
96 # Returns (None, "a message") if this didn't work, or (version, vercode, tag) for
97 # the details of the current version.
98 def check_tags(app, pattern):
102 if app['Repo Type'] == 'srclib':
103 build_dir = os.path.join('build', 'srclib', app['Repo'])
104 repotype = common.getsrclibvcs(app['Repo'])
106 build_dir = os.path.join('build/', app['id'])
107 repotype = app['Repo Type']
109 if repotype not in ('git', 'git-svn', 'hg', 'bzr'):
110 return (None, 'Tags update mode only works for git, hg, bzr and git-svn repositories currently', None)
112 if repotype == 'git-svn' and ';' not in app['Repo']:
113 return (None, 'Tags update mode used in git-svn, but the repo was not set up with tags', None)
115 # Set up vcs interface and make sure we have the latest code...
116 vcs = common.getvcs(app['Repo Type'], app['Repo'], build_dir)
118 vcs.gotorevision(None)
121 if len(app['builds']) > 0:
122 if app['builds'][-1]['subdir']:
123 build_dir = os.path.join(build_dir, app['builds'][-1]['subdir'])
124 if app['builds'][-1]['gradle']:
125 flavours = app['builds'][-1]['gradle']
133 logging.debug("All tags: " + ','.join(tags))
135 pat = re.compile(pattern)
136 tags = [tag for tag in tags if pat.match(tag)]
137 logging.debug("Matching tags: " + ','.join(tags))
139 if repotype in ('git',):
140 tags = vcs.latesttags(tags, 5)
141 logging.debug("Latest tags: " + ','.join(tags))
144 logging.debug("Check tag: '{0}'".format(tag))
145 vcs.gotorevision(tag)
147 # Only process tags where the manifest exists...
148 paths = common.manifest_paths(build_dir, flavours)
149 version, vercode, package = \
150 common.parse_androidmanifests(paths, app['Update Check Ignore'])
151 if not app_matches_packagename(app, package) or not version or not vercode:
154 logging.debug("Manifest exists. Found version {0} ({1})"
155 .format(version, vercode))
156 if int(vercode) > int(hcode):
159 hcode = str(int(vercode))
163 return (None, "Couldn't find package ID", None)
165 return (hver, hcode, htag)
166 return (None, "Couldn't find any version information", None)
168 except VCSException as vcse:
169 msg = "VCS error while scanning app {0}: {1}".format(app['id'], vcse)
170 return (None, msg, None)
172 msg = "Could not scan app {0} due to unknown error: {1}".format(app['id'], traceback.format_exc())
173 return (None, msg, None)
176 # Check for a new version by looking at the AndroidManifest.xml at the HEAD
177 # of the source repo. Whether this can be used reliably or not depends on
178 # the development procedures used by the project's developers. Use it with
179 # caution, because it's inappropriate for many projects.
180 # Returns (None, "a message") if this didn't work, or (version, vercode) for
181 # the details of the current version.
182 def check_repomanifest(app, branch=None):
186 if app['Repo Type'] == 'srclib':
187 build_dir = os.path.join('build', 'srclib', app['Repo'])
188 repotype = common.getsrclibvcs(app['Repo'])
190 build_dir = os.path.join('build/', app['id'])
191 repotype = app['Repo Type']
193 # Set up vcs interface and make sure we have the latest code...
194 vcs = common.getvcs(app['Repo Type'], app['Repo'], build_dir)
196 if repotype == 'git':
198 branch = 'origin/' + branch
199 vcs.gotorevision(branch)
200 elif repotype == 'git-svn':
201 vcs.gotorevision(branch)
202 elif repotype == 'hg':
203 vcs.gotorevision(branch)
204 elif repotype == 'bzr':
205 vcs.gotorevision(None)
208 if len(app['builds']) > 0:
209 if app['builds'][-1]['subdir']:
210 build_dir = os.path.join(build_dir, app['builds'][-1]['subdir'])
211 if app['builds'][-1]['gradle']:
212 flavours = app['builds'][-1]['gradle']
214 if not os.path.isdir(build_dir):
215 return (None, "Subdir '" + app['builds'][-1]['subdir'] + "'is not a valid directory")
217 paths = common.manifest_paths(build_dir, flavours)
219 version, vercode, package = \
220 common.parse_androidmanifests(paths, app['Update Check Ignore'])
222 return (None, "Couldn't find package ID")
223 if not app_matches_packagename(app, package):
224 return (None, "Package ID mismatch - got {0}".format(package))
226 return (None, "Couldn't find latest version name")
228 if "Ignore" == version:
229 return (None, "Latest version is ignored")
230 return (None, "Couldn't find latest version code")
232 vercode = str(int(vercode))
234 logging.debug("Manifest exists. Found version {0} ({1})".format(version, vercode))
236 return (version, vercode)
238 except VCSException as vcse:
239 msg = "VCS error while scanning app {0}: {1}".format(app['id'], vcse)
242 msg = "Could not scan app {0} due to unknown error: {1}".format(app['id'], traceback.format_exc())
246 def check_repotrunk(app, branch=None):
249 if app['Repo Type'] == 'srclib':
250 build_dir = os.path.join('build', 'srclib', app['Repo'])
251 repotype = common.getsrclibvcs(app['Repo'])
253 build_dir = os.path.join('build/', app['id'])
254 repotype = app['Repo Type']
256 if repotype not in ('git-svn', ):
257 return (None, 'RepoTrunk update mode only makes sense in git-svn repositories')
259 # Set up vcs interface and make sure we have the latest code...
260 vcs = common.getvcs(app['Repo Type'], app['Repo'], build_dir)
262 vcs.gotorevision(None)
266 except VCSException as vcse:
267 msg = "VCS error while scanning app {0}: {1}".format(app['id'], vcse)
270 msg = "Could not scan app {0} due to unknown error: {1}".format(app['id'], traceback.format_exc())
274 # Check for a new version by looking at the Google Play Store.
275 # Returns (None, "a message") if this didn't work, or (version, None) for
276 # the details of the current version.
277 def check_gplay(app):
279 url = 'https://play.google.com/store/apps/details?id=' + app['id']
280 headers = {'User-Agent': 'Mozilla/5.0 (X11; Linux i686; rv:18.0) Gecko/20100101 Firefox/18.0'}
281 req = urllib2.Request(url, None, headers)
283 resp = urllib2.urlopen(req, None, 20)
285 except urllib2.HTTPError, e:
286 return (None, str(e.code))
288 return (None, 'Failed:' + str(e))
292 m = re.search('itemprop="softwareVersion">[ ]*([^<]+)[ ]*</div>', page)
294 html_parser = HTMLParser.HTMLParser()
295 version = html_parser.unescape(m.group(1))
297 if version == 'Varies with device':
298 return (None, 'Device-variable version, cannot use this method')
301 return (None, "Couldn't find version")
302 return (version.strip(), None)
305 # Return all directories under startdir that contain any of the manifest
306 # files, and thus are probably an Android project.
307 def dirs_with_manifest(startdir):
308 for r, d, f in os.walk(startdir):
309 if any(m in f for m in [
310 'AndroidManifest.xml', 'pom.xml', 'build.gradle']):
314 # Tries to find a new subdir starting from the root build_dir. Returns said
315 # subdir relative to the build dir if found, None otherwise.
316 def check_changed_subdir(app):
318 if app['Repo Type'] == 'srclib':
319 build_dir = os.path.join('build', 'srclib', app['Repo'])
321 build_dir = os.path.join('build/', app['id'])
323 if not os.path.isdir(build_dir):
327 if len(app['builds']) > 0 and app['builds'][-1]['gradle']:
328 flavours = app['builds'][-1]['gradle']
330 for d in dirs_with_manifest(build_dir):
331 logging.debug("Trying possible dir %s." % d)
332 m_paths = common.manifest_paths(d, flavours)
333 package = common.parse_androidmanifests(m_paths, app['Update Check Ignore'])[2]
334 if app_matches_packagename(app, package):
335 logging.debug("Manifest exists in possible dir %s." % d)
336 return os.path.relpath(d, build_dir)
341 def fetch_autoname(app, tag):
343 if not app["Repo Type"] or app['Update Check Mode'] in ('None', 'Static'):
346 if app['Repo Type'] == 'srclib':
347 app_dir = os.path.join('build', 'srclib', app['Repo'])
349 app_dir = os.path.join('build/', app['id'])
352 vcs = common.getvcs(app["Repo Type"], app["Repo"], app_dir)
353 vcs.gotorevision(tag)
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 flavours = app['builds'][-1]['gradle']
364 logging.debug("...fetch auto name from " + app_dir)
365 new_name = common.fetch_real_name(app_dir, flavours)
368 logging.debug("...got autoname '" + new_name + "'")
369 if new_name != app['Auto Name']:
370 app['Auto Name'] = new_name
372 commitmsg = "Set autoname of {0}".format(common.getappname(app))
374 logging.debug("...couldn't get autoname")
379 def checkupdates_app(app, first=True):
381 # If a change is made, commitmsg should be set to a description of it.
382 # Only if this is set will changes be written back to the metadata.
389 mode = app['Update Check Mode']
390 if mode.startswith('Tags'):
391 pattern = mode[5:] if len(mode) > 4 else None
392 (version, vercode, tag) = check_tags(app, pattern)
394 elif mode == 'RepoManifest':
395 (version, vercode) = check_repomanifest(app)
397 elif mode.startswith('RepoManifest/'):
399 (version, vercode) = check_repomanifest(app, tag)
401 elif mode == 'RepoTrunk':
402 (version, vercode) = check_repotrunk(app)
405 (version, vercode) = check_http(app)
407 elif mode in ('None', 'Static'):
409 msg = 'Checking disabled'
413 msg = 'Invalid update check method'
415 if first and version is None and vercode == "Couldn't find package ID":
416 logging.warn("Couldn't find any version information. Looking for a subdir change...")
417 new_subdir = check_changed_subdir(app)
418 if new_subdir is None:
419 logging.warn("Couldn't find any new subdir.")
421 logging.warn("Trying a new subdir: %s" % new_subdir)
423 metadata.fill_build_defaults(new_build)
424 new_build['version'] = "Ignore"
425 new_build['vercode'] = "-1"
426 new_build['subdir'] = new_subdir
427 app['builds'].append(new_build)
428 return checkupdates_app(app, first=False)
430 if version and vercode and app['Vercode Operation']:
431 op = app['Vercode Operation'].replace("%c", str(int(vercode)))
432 vercode = str(eval(op))
436 logmsg = "...{0} : {1}".format(app['id'], msg)
441 elif vercode == app['Current Version Code']:
442 logging.info("...up to date")
444 app['Current Version'] = version
445 app['Current Version Code'] = str(int(vercode))
448 commitmsg = fetch_autoname(app, tag)
451 name = common.getappname(app)
452 ver = common.getcvname(app)
453 logging.info('...updating to version %s' % ver)
454 commitmsg = 'Update CV of %s to %s' % (name, ver)
457 mode = app['Auto Update Mode']
458 if mode in ('None', 'Static'):
460 elif mode.startswith('Version '):
462 if pattern.startswith('+'):
464 suffix, pattern = pattern.split(' ', 1)
466 raise MetaDataException("Invalid AUM: " + mode)
471 for build in app['builds']:
472 if build['vercode'] == app['Current Version Code']:
474 if not latest or int(build['vercode']) > int(latest['vercode']):
478 newbuild = latest.copy()
479 if 'origlines' in newbuild:
480 del newbuild['origlines']
481 newbuild['disable'] = False
482 newbuild['vercode'] = app['Current Version Code']
483 newbuild['version'] = app['Current Version'] + suffix
484 logging.info("...auto-generating build for " + newbuild['version'])
485 commit = pattern.replace('%v', newbuild['version'])
486 commit = commit.replace('%c', newbuild['vercode'])
487 newbuild['commit'] = commit
488 app['builds'].append(newbuild)
489 name = common.getappname(app)
490 ver = common.getcvname(app)
491 commitmsg = "Update %s to %s" % (name, ver)
493 logging.warn('Invalid auto update mode "' + mode + '" on ' + app['id'])
496 metafile = os.path.join('metadata', app['id'] + '.txt')
497 metadata.write_metadata(metafile, app)
499 logging.info("Commiting update for " + metafile)
500 gitcmd = ["git", "commit", "-m", commitmsg]
501 if 'auto_author' in config:
502 gitcmd.extend(['--author', config['auto_author']])
503 gitcmd.extend(["--", metafile])
504 if subprocess.call(gitcmd) != 0:
505 logging.error("Git commit failed")
515 global config, options
517 # Parse command line...
518 parser = OptionParser(usage="Usage: %prog [options] [APPID [APPID ...]]")
519 parser.add_option("-v", "--verbose", action="store_true", default=False,
520 help="Spew out even more information than normal")
521 parser.add_option("-q", "--quiet", action="store_true", default=False,
522 help="Restrict output to warnings and errors")
523 parser.add_option("--auto", action="store_true", default=False,
524 help="Process auto-updates")
525 parser.add_option("--autoonly", action="store_true", default=False,
526 help="Only process apps with auto-updates")
527 parser.add_option("--commit", action="store_true", default=False,
528 help="Commit changes")
529 parser.add_option("--gplay", action="store_true", default=False,
530 help="Only print differences with the Play Store")
531 (options, args) = parser.parse_args()
533 config = common.read_config(options)
536 allapps = metadata.read_metadata()
538 apps = common.read_app_args(args, allapps, False)
542 version, reason = check_gplay(app)
545 logging.info("{0} is not in the Play Store".format(common.getappname(app)))
547 logging.info("{0} encountered a problem: {1}".format(common.getappname(app), reason))
548 if version is not None:
549 stored = app['Current Version']
551 logging.info("{0} has no Current Version but has version {1} on the Play Store"
552 .format(common.getappname(app), version))
553 elif LooseVersion(stored) < LooseVersion(version):
554 logging.info("{0} has version {1} on the Play Store, which is bigger than {2}"
555 .format(common.getappname(app), version, stored))
557 if stored != version:
558 logging.info("{0} has version {1} on the Play Store, which differs from {2}"
559 .format(common.getappname(app), version, stored))
561 logging.info("{0} has the same version {1} on the Play Store"
562 .format(common.getappname(app), version))
565 for appid, app in apps.iteritems():
567 if options.autoonly and app['Auto Update Mode'] in ('None', 'Static'):
568 logging.debug("Nothing to do for {0}...".format(appid))
571 logging.info("Processing " + appid + '...')
573 checkupdates_app(app)
575 logging.info("Finished.")
577 if __name__ == "__main__":