From 6afc8364e018d56f68f40761396ed74f907d5ff9 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Thu, 23 May 2013 09:52:57 -0500 Subject: Generalize "gmg theme assetlink" -> "gmg assetlink" and cover both theme and plugins We've moved the module... probably I'll re-add theme just to give a warning that this is deprecated. This commit sponsored by Kevin Williams. Thank you! --- mediagoblin/gmg_commands/__init__.py | 14 ++- mediagoblin/gmg_commands/assetlink.py | 151 ++++++++++++++++++++++++++++ mediagoblin/gmg_commands/theme.py | 178 ---------------------------------- 3 files changed, 160 insertions(+), 183 deletions(-) create mode 100644 mediagoblin/gmg_commands/assetlink.py delete mode 100644 mediagoblin/gmg_commands/theme.py diff --git a/mediagoblin/gmg_commands/__init__.py b/mediagoblin/gmg_commands/__init__.py index 6aed4f6c..d8156126 100644 --- a/mediagoblin/gmg_commands/__init__.py +++ b/mediagoblin/gmg_commands/__init__.py @@ -41,11 +41,15 @@ SUBCOMMAND_MAP = { 'setup': 'mediagoblin.gmg_commands.dbupdate:dbupdate_parse_setup', 'func': 'mediagoblin.gmg_commands.dbupdate:dbupdate', 'help': 'Set up or update the SQL database'}, - 'theme': { - 'setup': 'mediagoblin.gmg_commands.theme:theme_parser_setup', - 'func': 'mediagoblin.gmg_commands.theme:theme', - 'help': 'Theming commands', - } + 'assetlink': { + 'setup': 'mediagoblin.gmg_commands.assetlink:assetlink_parser_setup', + 'func': 'mediagoblin.gmg_commands.assetlink:assetlink', + 'help': 'Link assets for themes and plugins for static serving'}, + # 'theme': { + # 'setup': 'mediagoblin.gmg_commands.theme:theme_parser_setup', + # 'func': 'mediagoblin.gmg_commands.theme:theme', + # 'help': 'Theming commands', + # } ## These might be useful, mayyyybe, but don't really work anymore ## due to mongo change and the "versatility" of sql options. diff --git a/mediagoblin/gmg_commands/assetlink.py b/mediagoblin/gmg_commands/assetlink.py new file mode 100644 index 00000000..387658ac --- /dev/null +++ b/mediagoblin/gmg_commands/assetlink.py @@ -0,0 +1,151 @@ +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +import os + +from mediagoblin import mg_globals +from mediagoblin.init import setup_global_and_app_config +from mediagoblin.gmg_commands import util as commands_util +from mediagoblin.tools.theme import register_themes +from mediagoblin.tools.translate import pass_to_ugettext as _ +from mediagoblin.tools.common import simple_printer +from mediagoblin.tools import pluginapi + + +def assetlink_parser_setup(subparser): + # theme_subparsers = subparser.add_subparsers( + # dest=u"subcommand", + # help=u'Assetlink options') + + # # Install command + # install_parser = theme_subparsers.add_parser( + # u'install', help=u'Install a theme to this mediagoblin instance') + # install_parser.add_argument( + # u'themefile', help=u'The theme archive to be installed') + + # theme_subparsers.add_parser( + # u'assetlink', + # help=( + # u"Link the currently installed theme's assets " + # u"to the served theme asset directory")) + pass + + +########### +# Utilities +########### + +def link_theme_assets(theme, link_dir, printer=simple_printer): + """ + Returns a list of string of text telling the user what we did + which should be printable. + """ + link_dir = link_dir.rstrip(os.path.sep) + link_parent_dir = os.path.dirname(link_dir) + + if theme is None: + printer(_("Cannot link theme... no theme set\n")) + return + + def _maybe_unlink_link_dir(): + """unlink link directory if it exists""" + if os.path.lexists(link_dir) \ + and os.path.islink(link_dir): + os.unlink(link_dir) + return True + + return + + if theme.get('assets_dir') is None: + printer(_("No asset directory for this theme\n")) + if _maybe_unlink_link_dir(): + printer( + _("However, old link directory symlink found; removed.\n")) + return + + _maybe_unlink_link_dir() + + # make the link directory parent dirs if necessary + if not os.path.lexists(link_parent_dir): + os.makedirs(link_parent_dir) + + os.symlink( + theme['assets_dir'].rstrip(os.path.sep), + link_dir) + printer("Linked the theme's asset directory:\n %s\nto:\n %s\n" % ( + theme['assets_dir'], link_dir)) + + +def link_plugin_assets(plugin_static, plugins_link_dir, printer=simple_printer): + """ + Arguments: + - plugin_static: a mediagoblin.tools.staticdirect.PluginStatic instance + representing the static assets of this plugins' configuration + - plugins_link_dir: Base directory plugins are linked from + """ + # link_dir is the final directory we'll link to, a combination of + # the plugin assetlink directory and plugin_static.name + link_dir = os.path.sep.join( + [plugins_link_dir.rstrip(os.path.sep), plugin_static.name]) + + # make the link directory parent dirs if necessary + if not os.path.lexists(plugins_link_dir): + os.makedirs(plugins_link_dir) + + # See if the link_dir already exists. + if os.path.lexists(link_dir): + # if this isn't a symlink, there's something wrong... error out. + if not os.path.islink(link_dir): + printer(_('Could not link "%s": %s exists and is not a symlink\n') % ( + plugin_static.name, link_dir)) + return + + # if this is a symlink and the path already exists, skip it. + if os.path.realpath(link_dir) == plugin_static.file_path: + # Is this comment helpful or not? + printer(_('Skipping "%s"; already set up.\n') % ( + plugin_static.name)) + return + + # Otherwise, it's a link that went to something else... unlink it + printer(_('Old link found for "%s"; removing.\n') % ( + plugin_static.name)) + os.unlink(link_dir) + + os.symlink( + plugin_static.file_path.rstrip(os.path.sep), + link_dir) + printer('Linked asset directory for plugin "%s":\n %s\nto:\n %s\n' % ( + plugin_static.name, + plugin_static.file_path.rstrip(os.path.sep), + link_dir)) + + +def assetlink(args): + """ + Link the asset directory of the currently installed theme + """ + mgoblin_app = commands_util.setup_app(args) + app_config = mg_globals.app_config + + # link theme + link_theme_assets(mgoblin_app.current_theme, app_config['theme_linked_assets_dir']) + + # link plugin assets + ## ... probably for this we need the whole application initialized + for plugin_static in pluginapi.hook_runall("static_setup"): + link_plugin_assets( + plugin_static, app_config['plugin_linked_assets_dir']) diff --git a/mediagoblin/gmg_commands/theme.py b/mediagoblin/gmg_commands/theme.py deleted file mode 100644 index adf50d5a..00000000 --- a/mediagoblin/gmg_commands/theme.py +++ /dev/null @@ -1,178 +0,0 @@ -# GNU MediaGoblin -- federated, autonomous media hosting -# Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU Affero General Public License for more details. -# -# You should have received a copy of the GNU Affero General Public License -# along with this program. If not, see . - -import os - -from mediagoblin.init import setup_global_and_app_config -from mediagoblin.gmg_commands import util as commands_util -from mediagoblin.tools.theme import register_themes -from mediagoblin.tools.translate import pass_to_ugettext as _ -from mediagoblin.tools.common import simple_printer -from mediagoblin.tools import pluginapi - - -def theme_parser_setup(subparser): - theme_subparsers = subparser.add_subparsers( - dest=u"subcommand", - help=u'Theme sub-commands') - - # Install command - install_parser = theme_subparsers.add_parser( - u'install', help=u'Install a theme to this mediagoblin instance') - install_parser.add_argument( - u'themefile', help=u'The theme archive to be installed') - - theme_subparsers.add_parser( - u'assetlink', - help=( - u"Link the currently installed theme's assets " - u"to the served theme asset directory")) - - -########### -# Utilities -########### - -def link_theme_assets(theme, link_dir, printer=simple_printer): - """ - Returns a list of string of text telling the user what we did - which should be printable. - """ - link_dir = link_dir.rstrip(os.path.sep) - link_parent_dir = os.path.dirname(link_dir) - - if theme is None: - printer(_("Cannot link theme... no theme set\n")) - return - - def _maybe_unlink_link_dir(): - """unlink link directory if it exists""" - if os.path.lexists(link_dir) \ - and os.path.islink(link_dir): - os.unlink(link_dir) - return True - - return - - if theme.get('assets_dir') is None: - printer(_("No asset directory for this theme\n")) - if _maybe_unlink_link_dir(): - printer( - _("However, old link directory symlink found; removed.\n")) - return - - _maybe_unlink_link_dir() - - # make the link directory parent dirs if necessary - if not os.path.lexists(link_parent_dir): - os.makedirs(link_parent_dir) - - os.symlink( - theme['assets_dir'].rstrip(os.path.sep), - link_dir) - printer("Linked the theme's asset directory:\n %s\nto:\n %s\n" % ( - theme['assets_dir'], link_dir)) - - -def link_plugin_assets(plugin_static, plugins_link_dir, printer=simple_printer): - """ - Arguments: - - plugin_static: a mediagoblin.tools.staticdirect.PluginStatic instance - representing the static assets of this plugins' configuration - - plugins_link_dir: Base directory plugins are linked from - """ - # link_dir is the final directory we'll link to, a combination of - # the plugin assetlink directory and plugin_static.name - link_dir = os.path.sep.join( - [plugins_link_dir.rstrip(os.path.sep), plugin_static.name]) - - # make the link directory parent dirs if necessary - if not os.path.lexists(plugins_link_dir): - os.makedirs(plugins_link_dir) - - # See if the link_dir already exists. - if os.path.lexists(link_dir): - # if this isn't a symlink, there's something wrong... error out. - if not os.path.islink(link_dir): - printer(_('Could not link "%s": %s exists and is not a symlink\n') % ( - plugin_static.name, link_dir)) - return - - # if this is a symlink and the path already exists, skip it. - if os.path.realpath(link_dir) == plugin_static.file_path: - # Is this comment helpful or not? - printer(_('Skipping "%s"; already set up.\n') % ( - plugin_static.name)) - return - - # Otherwise, it's a link that went to something else... unlink it - printer(_('Old link found for "%s"; removing.\n') % ( - plugin_static.name)) - os.unlink(link_dir) - - os.symlink( - plugin_static.file_path.rstrip(os.path.sep), - link_dir) - printer('Linked asset directory for plugin "%s":\n %s\nto:\n %s\n' % ( - plugin_static.name, - plugin_static.file_path.rstrip(os.path.sep), - link_dir)) - - -def install_theme(install_dir, themefile): - pass # TODO ;) - - -############# -# Subcommands -############# - -def assetlink_command(args): - """ - Link the asset directory of the currently installed theme - """ - global_config, app_config = setup_global_and_app_config(args.conf_file) - theme_registry, current_theme = register_themes(app_config) - - # link theme - link_theme_assets(current_theme, app_config['theme_linked_assets_dir']) - - # Set up the app specifically so we can access the plugin infrastructure - commands_util.setup_app(args) - - # link plugin assets - ## ... probably for this we need the whole application initialized - for plugin_static in pluginapi.hook_runall("static_setup"): - link_plugin_assets( - plugin_static, app_config['plugin_linked_assets_dir']) - - -def install_command(args): - """ - Handle the 'install this theme' subcommand - """ - global_config, app_config = setup_global_and_app_config(args.conf_file) - install_dir = app_config['theme_install_dir'] - install_theme(install_dir, args.themefile) - - -SUBCOMMANDS = { - 'assetlink': assetlink_command, - 'install': install_command} - - -def theme(args): - SUBCOMMANDS[args.subcommand](args) -- cgit v1.2.3