chiark / gitweb /
dont list fdroid subcommands in random order
[fdroidserver.git] / fdroid
1 #!/usr/bin/env python3
2 #
3 # fdroid.py - part of the FDroid server tools
4 # Copyright (C) 2010-2015, Ciaran Gultnieks, ciaran@ciarang.com
5 # Copyright (C) 2013-2014 Daniel Marti <mvdan@mvdan.cc>
6 #
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 # GNU Affero General Public License for more details.
16 #
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20 import sys
21 import logging
22
23 import fdroidserver.common
24 import fdroidserver.metadata
25 from argparse import ArgumentError
26 from collections import OrderedDict
27
28 commands = OrderedDict([
29     ("build", "Build a package from source"),
30     ("init", "Quickly start a new repository"),
31     ("publish", "Sign and place packages in the repo"),
32     ("gpgsign", "Add gpg signatures for packages in repo"),
33     ("update", "Update repo information for new packages"),
34     ("verify", "Verify the integrity of downloaded packages"),
35     ("checkupdates", "Check for updates to applications"),
36     ("import", "Add a new application from its source code"),
37     ("install", "Install built packages on devices"),
38     ("readmeta", "Read all the metadata files and exit"),
39     ("rewritemeta", "Rewrite all the metadata files"),
40     ("lint", "Warn about possible metadata errors"),
41     ("scanner", "Scan the source code of a package"),
42     ("dscanner", "Dynamically scan APKs post build"),
43     ("stats", "Update the stats of the repo"),
44     ("server", "Interact with the repo HTTP server"),
45     ("signindex", "Sign indexes created using update --nosign"),
46     ("btlog", "Update the binary transparency log for a URL"),
47 ])
48
49
50 def print_help():
51     print("usage: fdroid [-h|--help|--version] <command> [<args>]")
52     print("")
53     print("Valid commands are:")
54     for cmd, summary in commands.items():
55         print("   " + cmd + ' ' * (15 - len(cmd)) + summary)
56     print("")
57
58
59 def main():
60
61     if len(sys.argv) <= 1:
62         print_help()
63         sys.exit(0)
64
65     command = sys.argv[1]
66     if command not in commands:
67         if command in ('-h', '--help'):
68             print_help()
69             sys.exit(0)
70         elif command == '--version':
71             import os.path
72             output = 'no version info found!'
73             cmddir = os.path.realpath(os.path.dirname(__file__))
74             moduledir = os.path.realpath(os.path.dirname(fdroidserver.common.__file__) + '/..')
75             if cmddir == moduledir:
76                 # running from git
77                 os.chdir(cmddir)
78                 if os.path.isdir('.git'):
79                     import subprocess
80                     try:
81                         output = subprocess.check_output(['git', 'describe'],
82                                                          stderr=subprocess.STDOUT,
83                                                          universal_newlines=True)
84                     except subprocess.CalledProcessError:
85                         output = 'git commit ' + subprocess.check_output(['git', 'rev-parse', 'HEAD'],
86                                                                          universal_newlines=True)
87                 elif os.path.exists('setup.py'):
88                     import re
89                     m = re.search(r'''.*[\s,\(]+version\s*=\s*["']([0-9a-z.]+)["'].*''',
90                                   open('setup.py').read(), flags=re.MULTILINE)
91                     if m:
92                         output = m.group(1) + '\n'
93             else:
94                 from pkg_resources import get_distribution
95                 output = get_distribution('fdroidserver').version + '\n'
96             print(output),
97             sys.exit(0)
98         else:
99             print("Command '%s' not recognised.\n" % command)
100             print_help()
101             sys.exit(1)
102
103     verbose = any(s in sys.argv for s in ['-v', '--verbose'])
104     quiet = any(s in sys.argv for s in ['-q', '--quiet'])
105
106     # Helpful to differentiate warnings from errors even when on quiet
107     logformat = '%(levelname)s: %(message)s'
108     loglevel = logging.INFO
109     if verbose:
110         loglevel = logging.DEBUG
111     elif quiet:
112         loglevel = logging.WARN
113
114     logging.basicConfig(format=logformat, level=loglevel)
115
116     if verbose and quiet:
117         logging.critical("Specifying --verbose and --quiet and the same time is silly")
118         sys.exit(1)
119
120     # Trick optparse into displaying the right usage when --help is used.
121     sys.argv[0] += ' ' + command
122
123     del sys.argv[1]
124     mod = __import__('fdroidserver.' + command, None, None, [command])
125
126     try:
127         mod.main()
128     # These are ours, contain a proper message and are "expected"
129     except (fdroidserver.common.FDroidException,
130             fdroidserver.metadata.MetaDataException) as e:
131         if verbose:
132             raise
133         else:
134             logging.critical(str(e))
135         sys.exit(1)
136     except ArgumentError as e:
137         logging.critical(str(e))
138         sys.exit(1)
139     except KeyboardInterrupt:
140         print('')
141         sys.exit(1)
142     # These should only be unexpected crashes due to bugs in the code
143     # str(e) often doesn't contain a reason, so just show the backtrace
144     except Exception as e:
145         logging.critical("Unknown exception found!")
146         raise
147     sys.exit(0)
148
149
150 if __name__ == "__main__":
151     main()