cubicweb: comparison cwctl.py

equal deleted inserted replaced

-:ea75dfe32317
+:e951a860eeaf
 """%%prog %s [options] %s
 CubicWeb main applications controller.
 %s"""
 import sys
 from os import remove, listdir, system, kill, getpgid, pathsep
 from os.path import exists, join, isfile, isdir
 from logilab.common.clcommands import register_commands, pop_arg
 from cubicweb import ConfigurationError, ExecutionError, BadCommandUsage
 from cubicweb.cwconfig import CubicWebConfiguration as cwcfg, CONFIGURATIONS
 from cubicweb.toolsutils import Command, main_run,  rm, create_dir, confirm
 def wait_process_end(pid, maxtry=10, waittime=1):
 """wait for a process to actually die"""
 import signal
 from time import sleep
 nbtry = 0
 for fname in ('data', 'views', 'views.py'):
 if exists(join(templdir, fname)):
 modes.append('web ui')
 break
 return modes
 class ApplicationCommand(Command):
 """base class for command taking 0 to n application id as arguments
 (0 meaning all registered applications)
 """
 arguments = '[<application>...]'
 options = (
 ("force",
 {'short': 'f', 'action' : 'store_true',
 'default': False,
 'help': 'force command without asking confirmation',
 }
 ),
 )
 actionverb = None
 def ordered_instances(self):
 """return instances in the order in which they should be started,
 considering $REGISTRY_DIR/startorder file if it exists (useful when
 some instances depends on another as external source
 """
 'instance %s' % line)
 allinstances += _allinstances
 else:
 allinstances = _allinstances
 return allinstances
 def run(self, args):
 """run the <command>_method on each argument (a list of application
 identifiers)
 """
 if not args:
 # no force option
 askconfirm = False
 else:
 askconfirm = False
 self.run_args(args, askconfirm)
 def run_args(self, args, askconfirm):
 for appid in args:
 if askconfirm:
 print '*'*72
 if not confirm('%s application %r ?' % (self.name, appid)):
 continue
 self.run_arg(appid)
 def run_arg(self, appid):
 cmdmeth = getattr(self, '%s_application' % self.name)
 try:
 cmdmeth(appid)
 except (KeyboardInterrupt, SystemExit):
 status = system('%s %s' % (forkcmd, appid))
 if status:
 sys.exit(status)
 else:
 self.run_arg(appid)
 # base commands ###############################################################
 class ListCommand(Command):
 """List configurations, componants and applications.
 registered applications
 """
 name = 'list'
 options = (
 ('verbose',
 {'short': 'v', 'action' : 'store_true',
 'help': "display more information."}),
 )
 def run(self, args):
 """run the command with its specific arguments"""
 if args:
 raise BadCommandUsage('Too much arguments')
 print 'CubicWeb version:', cwcfg.cubicweb_version()
 for line in config.__doc__.splitlines():
 line = line.strip()
 if not line:
 continue
 print '   ', line
 print
 try:
 cubesdir = pathsep.join(cwcfg.cubes_search_path())
 namesize = max(len(x) for x in cwcfg.available_cubes())
 except ConfigurationError, ex:
 print 'No cubes available:', ex
 print '* %s (BROKEN application, no configuration found)' % appid
 continue
 print '* %s (%s)' % (appid, ', '.join(modes))
 try:
 config = cwcfg.config_for(appid, modes[0])
 except Exception, exc:
 print '    (BROKEN application, %s)' % exc
 continue
 else:
 print 'No application available in %s' % regdir
 print
 command. Default to "all-in-one", e.g. an installation embedding both the RQL \
 repository and the web server.',
 }
 ),
 )
 def run(self, args):
 """run the command with its specific arguments"""
 from logilab.common.textutils import get_csv
 configname = self.config.config
 cubes = get_csv(pop_arg(args, 1))
 print 'application %s (%s) created in %r' % (appid, configname,
 config.apphome)
 print
 helper.postcreate()
 class DeleteApplicationCommand(Command):
 """Delete an application. Will remove application's files and
 unregister it.
 """
 name = 'delete'
 arguments = '<application>'
 options = ()
 def run(self, args):
 """run the command with its specific arguments"""
 appid = pop_arg(args, msg="No application specified !")
 # application commands ########################################################
 class StartApplicationCommand(ApplicationCommand):
 """Start the given applications. If no application is given, start them all.
 <application>...
 identifiers of the applications to start. If no application is
 given, start them all.
 """
 name = 'start'
 return True
 class StopApplicationCommand(ApplicationCommand):
 """Stop the given applications.
 <application>...
 identifiers of the applications to stop. If no application is
 given, stop them all.
 """
 name = 'stop'
 actionverb = 'stopped'
 def ordered_instances(self):
 instances = super(StopApplicationCommand, self).ordered_instances()
 instances.reverse()
 return instances
 def stop_application(self, appid):
 """stop the application's server"""
 config = cwcfg.config_for(appid)
 helper = self.config_helper(config, cmdname='stop')
 helper.poststop() # do this anyway
 remove(pidf)
 except OSError:
 # already removed by twistd
 pass
 print 'application %s stopped' % appid
 class RestartApplicationCommand(StartApplicationCommand,
 StopApplicationCommand):
 """Restart the given applications.
 <application>...
 identifiers of the applications to restart. If no application is
 given, restart them all.
 """
 name = 'restart'
 forkcmd = ' '.join(forkcmd)
 for appid in reversed(args):
 status = system('%s %s' % (forkcmd, appid))
 if status:
 sys.exit(status)
 def restart_application(self, appid):
 self.stop_application(appid)
 if self.start_application(appid):
 print 'application %s %s' % (appid, self.actionverb)
 class ReloadConfigurationCommand(RestartApplicationCommand):
 """Reload the given applications. This command is equivalent to a
 restart for now.
 <application>...
 identifiers of the applications to reload. If no application is
 given, reload them all.
 """
 name = 'reload'
 def reload_application(self, appid):
 self.restart_application(appid)
 class StatusCommand(ApplicationCommand):
 """Display status information about the given applications.
 <application>...
 identifiers of the applications to status. If no application is
 given, get status information about all registered applications.
 """
 name = 'status'
 'help': 'force migration from the indicated  version for the specified cube.'}),
 ('force-cubicweb-version',
 {'short': 'e', 'type' : 'string', 'metavar': 'X.Y.Z',
 'default': None,
 'help': 'force migration from the indicated cubicweb version.'}),
 ('fs-only',
 {'short': 's', 'action' : 'store_true',
 'default': False,
 'help': 'only upgrade files on the file system, not the database.'}),
 ('nostartstop',
 {'short': 'n', 'action' : 'store_true',
 'default': False,
 'help': 'don\'t try to stop application before migration and to restart it after.'}),
 ('verbosity',
 {'short': 'v', 'type' : 'int', 'metavar': '<0..2>',
 'default': 1,
 'help': "0: no confirmation, 1: only main commands confirmed, 2 ask \
 for everything."}),
 ('backup-db',
 {'short': 'b', 'type' : 'yn', 'metavar': '<y or n>',
 'default': None,
 'help': "Backup the application database before upgrade.\n"\
 "If the option is ommitted, confirmation will be ask.",
 )
 def ordered_instances(self):
 # need this since mro return StopApplicationCommand implementation
 return ApplicationCommand.ordered_instances(self)
 def upgrade_application(self, appid):
 from logilab.common.changelog import Version
 if not (cwcfg.mode == 'dev' or self.config.nostartstop):
 self.stop_application(appid)
 config = cwcfg.config_for(appid)
 except KeyError:
 config.error('no version information for %s' % cube)
 continue
 if installedversion > applversion:
 toupgrade.append( (cube, applversion, installedversion) )
 cubicwebversion = config.cubicweb_version()
 if self.config.force_cubicweb_version:
 applcubicwebversion = Version(self.config.force_cubicweb_version)
 vcconf['cubicweb'] = applcubicwebversion
 else:
 applcubicwebversion = vcconf.get('cubicweb')
 {'short': 'S', 'action' : 'store_true',
 'default': False,
 'help': 'only connect to the system source when the instance is '
 'using multiple sources. You can\'t use this option and the '
 '--ext-sources option at the same time.'}),
 ('ext-sources',
 {'short': 'E', 'type' : 'csv', 'metavar': '<sources>',
 'default': None,
 'help': "For multisources instances, specify to which sources the \
 repository should connect to for upgrading. When unspecified or 'all' given, \
 will connect to all defined sources. If 'migration' is given, appropriate \
 sources for migration will be automatically selected.",
 }),
 )
 def run(self, args):
 appid = pop_arg(args, 99, msg="No application specified !")
 config = cwcfg.config_for(appid)
 if self.config.ext_sources:
 mih = config.migration_handler()
 if args:
 mih.scripts_session(args)
 else:
 mih.interactive_shell()
 mih.shutdown()
 class RecompileApplicationCatalogsCommand(ApplicationCommand):
 """Recompile i18n catalogs for applications.
 <application>...
 identifiers of the applications to consider. If no application is
 given, recompile for all registered applications.
 """
 name = 'i18ncompile'
 class ListInstancesCommand(Command):
 """list available instances, useful for bash completion."""
 name = 'listinstances'
 hidden = True
 def run(self, args):
 """run the command with its specific arguments"""
 regdir = cwcfg.registry_dir()
 for appid in sorted(listdir(regdir)):
 print appid
 class ListCubesCommand(Command):
 """list available componants, useful for bash completion."""
 name = 'listcubes'
 hidden = True
 def run(self, args):
 """run the command with its specific arguments"""
 for cube in cwcfg.available_cubes():
 print cube
 ShellCommand,
 RecompileApplicationCatalogsCommand,
 ListInstancesCommand, ListCubesCommand,
 ))
 def run(args):
 """command line tool"""
 cwcfg.load_cwctl_plugins()
 main_run(args, __doc__)

branch	tls-sprint
changeset 1446	e951a860eeaf
parent 1342	4273e44852cb
child 1477	b056a49c16dc