aboutsummaryrefslogtreecommitdiffstats
path: root/mediagoblin/init/celery
diff options
context:
space:
mode:
Diffstat (limited to 'mediagoblin/init/celery')
-rw-r--r--mediagoblin/init/celery/__init__.py99
-rw-r--r--mediagoblin/init/celery/dummy_settings_module.py0
-rw-r--r--mediagoblin/init/celery/from_celery.py96
3 files changed, 195 insertions, 0 deletions
diff --git a/mediagoblin/init/celery/__init__.py b/mediagoblin/init/celery/__init__.py
new file mode 100644
index 00000000..169cc935
--- /dev/null
+++ b/mediagoblin/init/celery/__init__.py
@@ -0,0 +1,99 @@
+# 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 <http://www.gnu.org/licenses/>.
+
+import os
+import sys
+
+from celery import Celery
+from mediagoblin.tools.pluginapi import hook_runall
+
+
+MANDATORY_CELERY_IMPORTS = ['mediagoblin.processing.task']
+
+DEFAULT_SETTINGS_MODULE = 'mediagoblin.init.celery.dummy_settings_module'
+
+
+def get_celery_settings_dict(app_config, global_config,
+ force_celery_always_eager=False):
+ """
+ Get a celery settings dictionary from reading the config
+ """
+ if 'celery' in global_config:
+ celery_conf = global_config['celery']
+ else:
+ celery_conf = {}
+
+ celery_settings = {}
+
+ # Add all celery settings from config
+ for key, value in celery_conf.iteritems():
+ celery_settings[key] = value
+
+ # TODO: use default result stuff here if it exists
+
+ # add mandatory celery imports
+ celery_imports = celery_settings.setdefault('CELERY_IMPORTS', [])
+ celery_imports.extend(MANDATORY_CELERY_IMPORTS)
+
+ if force_celery_always_eager:
+ celery_settings['CELERY_ALWAYS_EAGER'] = True
+ celery_settings['CELERY_EAGER_PROPAGATES_EXCEPTIONS'] = True
+
+ return celery_settings
+
+
+def setup_celery_app(app_config, global_config,
+ settings_module=DEFAULT_SETTINGS_MODULE,
+ force_celery_always_eager=False):
+ """
+ Setup celery without using terrible setup-celery-module hacks.
+ """
+ celery_settings = get_celery_settings_dict(
+ app_config, global_config, force_celery_always_eager)
+ celery_app = Celery()
+ celery_app.config_from_object(celery_settings)
+
+ hook_runall('celery_setup', celery_app)
+
+
+def setup_celery_from_config(app_config, global_config,
+ settings_module=DEFAULT_SETTINGS_MODULE,
+ force_celery_always_eager=False,
+ set_environ=True):
+ """
+ Take a mediagoblin app config and try to set up a celery settings
+ module from this.
+
+ Args:
+ - app_config: the application config section
+ - global_config: the entire ConfigObj loaded config, all sections
+ - settings_module: the module to populate, as a string
+ - force_celery_always_eager: whether or not to force celery into
+ always eager mode; good for development and small installs
+ - set_environ: if set, this will CELERY_CONFIG_MODULE to the
+ settings_module
+ """
+ celery_settings = get_celery_settings_dict(
+ app_config, global_config, force_celery_always_eager)
+
+ __import__(settings_module)
+ this_module = sys.modules[settings_module]
+
+ for key, value in celery_settings.iteritems():
+ setattr(this_module, key, value)
+
+ if set_environ:
+ os.environ['CELERY_CONFIG_MODULE'] = settings_module
diff --git a/mediagoblin/init/celery/dummy_settings_module.py b/mediagoblin/init/celery/dummy_settings_module.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/mediagoblin/init/celery/dummy_settings_module.py
diff --git a/mediagoblin/init/celery/from_celery.py b/mediagoblin/init/celery/from_celery.py
new file mode 100644
index 00000000..b395a826
--- /dev/null
+++ b/mediagoblin/init/celery/from_celery.py
@@ -0,0 +1,96 @@
+# 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 <http://www.gnu.org/licenses/>.
+
+import os
+import logging
+import logging.config
+
+from celery.signals import setup_logging
+
+from mediagoblin import app, mg_globals
+from mediagoblin.init.celery import setup_celery_from_config
+from mediagoblin.tools.pluginapi import hook_runall
+
+
+OUR_MODULENAME = __name__
+
+_log = logging.getLogger(__name__)
+
+
+def setup_logging_from_paste_ini(loglevel, **kw):
+ if os.path.exists(os.path.abspath('paste_local.ini')):
+ logging_conf_file = 'paste_local.ini'
+ else:
+ logging_conf_file = 'paste.ini'
+
+ # allow users to set up explicitly which paste file to check via the
+ # PASTE_CONFIG environment variable
+ logging_conf_file = os.environ.get(
+ 'PASTE_CONFIG', logging_conf_file)
+
+ if not os.path.exists(logging_conf_file):
+ raise IOError('{0} does not exist. Logging can not be set up.'.format(
+ logging_conf_file))
+
+ logging.config.fileConfig(logging_conf_file)
+
+ hook_runall('celery_logging_setup')
+
+
+setup_logging.connect(setup_logging_from_paste_ini)
+
+
+def setup_self(check_environ_for_conf=True, module_name=OUR_MODULENAME,
+ default_conf_file=None):
+ """
+ Transform this module into a celery config module by reading the
+ mediagoblin config file. Set the environment variable
+ MEDIAGOBLIN_CONFIG to specify where this config file is.
+
+ By default it defaults to 'mediagoblin.ini'.
+
+ Note that if celery_setup_elsewhere is set in your config file,
+ this simply won't work.
+ """
+ if not default_conf_file:
+ if os.path.exists(os.path.abspath('mediagoblin_local.ini')):
+ default_conf_file = 'mediagoblin_local.ini'
+ else:
+ default_conf_file = 'mediagoblin.ini'
+
+ if check_environ_for_conf:
+ mgoblin_conf_file = os.path.abspath(
+ os.environ.get('MEDIAGOBLIN_CONFIG', default_conf_file))
+ else:
+ mgoblin_conf_file = default_conf_file
+
+ if not os.path.exists(mgoblin_conf_file):
+ raise IOError(
+ "MEDIAGOBLIN_CONFIG not set or file does not exist")
+
+ # By setting the environment variable here we should ensure that
+ # this is the module that gets set up.
+ os.environ['CELERY_CONFIG_MODULE'] = module_name
+ app.MediaGoblinApp(mgoblin_conf_file, setup_celery=False)
+
+ setup_celery_from_config(
+ mg_globals.app_config, mg_globals.global_config,
+ settings_module=module_name,
+ set_environ=False)
+
+
+if os.environ['CELERY_CONFIG_MODULE'] == OUR_MODULENAME:
+ setup_self()