diff options
64 files changed, 3507 insertions, 38 deletions
@@ -7,6 +7,7 @@ /build/ /eggs/ /lib/ +/lib64 /local/ /include/ /parts/ @@ -71,6 +71,7 @@ Thank you! * Praveen Kumar * Rasmus Larsson * Rodney Ewing +* Rodrigo Rodrigues da Silva * Runar Petursson * Sacha De'Angeli * Sam Clegg @@ -1,13 +1,13 @@ # Extraction from Python source files [python: mediagoblin/**.py] -# Extraction from Genshi HTML and text templates +# Extraction from Jinja2 HTML and text templates [jinja2: mediagoblin/**/templates/**.html] -# Extract jinja templates (html) +# Extract Jinja2 templates (html) encoding = utf-8 extensions = jinja2.ext.autoescape, mediagoblin.tools.template.TemplateHookExtension [jinja2: mediagoblin/templates/**.txt] -# Extract jinja templates (text) +# Extract Jinja2 templates (text) encoding = utf-8 extensions = jinja2.ext.autoescape diff --git a/configure.ac b/configure.ac index e56a55a5..b3933e88 100644 --- a/configure.ac +++ b/configure.ac @@ -147,7 +147,7 @@ AC_PROG_INSTALL # Check for a supported database program AC_PATH_PROG([SQLITE], [sqlite3]) -AC_PATH_PROG([POSTGRES], [postgres]) +AC_PATH_PROG([POSTGRES], [psql]) AS_IF([test "x$SQLITE" = x -a "x$POSTGRES" = "x"], [AC_MSG_ERROR([SQLite or PostgreSQL is required])]) diff --git a/docs/source/siteadmin/commandline-upload.rst b/docs/source/siteadmin/commandline-upload.rst index be19df58..5ec0bb12 100644 --- a/docs/source/siteadmin/commandline-upload.rst +++ b/docs/source/siteadmin/commandline-upload.rst @@ -39,3 +39,70 @@ You can also pass in the `--celery` option if you would prefer that your media be passed over to celery to be processed rather than be processed immediately. +============================ +Command-line batch uploading +============================ + +There's another way to submit media, and it can be much more powerful, although +it is a bit more complex. + + ./bin/gmg batchaddmedia admin /path/to/your/metadata.csv + +This is an example of what a script may look like. The important part here is +that you have to create the 'metadata.csv' file.:: + + media:location,dcterms:title,dcterms:creator,dcterms:type + "http://www.example.net/path/to/nap.png","Goblin taking a nap",,"Image" + "http://www.example.net/path/to/snore.ogg","Goblin Snoring","Me","Audio" + +The above is an example of a very simple metadata.csv file. The batchaddmedia +script would read this and attempt to upload only two pieces of media, and would +be able to automatically name them appropriately. + +The csv file +============ +The location column +------------------- +The location column is the one column that is absolutely necessary for +uploading your media. This gives a path to each piece of media you upload. This +can either a path to a local file or a direct link to remote media (with the +link in http format). As you can see in the example above the (fake) media was +stored remotely on "www.example.net". + +Other internal nodes +-------------------- +There are other columns which can be used by the script to provide information. +These are not stored as part of the media's metadata. You can use these columns to +provide default information for your media entry, but as you'll see below, it's +just as easy to provide this information through the correct metadata columns. + +- **id** is used to identify the media entry to the user in case of an error in the batchaddmedia script. +- **license** is used to set a license for your piece a media for mediagoblin's use. This must be a URI. +- **title** will set the title displayed to mediagoblin users. +- **description** will set a description of your media. + +Metadata columns +---------------- +Other columns can be used to provide detailed metadata about each media entry. +Our metadata system accepts any information provided for in the +`RDFa Core Initial Context`_, and the batchupload script recognizes all of the +resources provided within it. + +.. _RDFa Core Initial Context: http://www.w3.org/2011/rdfa-context/rdfa-1.1 + +The uploader may include the metadata for each piece of media, or +leave them blank if they want to. A few columns from `Dublin Core`_ are +notable because the batchaddmedia script also uses them to set the default +information of uploaded media entries. + +.. _Dublin Core: http://wiki.dublincore.org/index.php/User_Guide + +- **dc:title** sets a title for your media entry. +- **dc:description** sets a description of your media entry. + +If both a metadata column and an internal node for the title are provided, mediagoblin +will use the internal node as the media entry's display name. This makes it so +that if you want to display a piece of media with a different title +than the one provided in its metadata, you can just provide different data for +the 'dc:title' and 'title' columns. The same is true of the 'description' and +'dc:description'. diff --git a/docs/source/siteadmin/deploying.rst b/docs/source/siteadmin/deploying.rst index 0dde3b6a..3ff2b9ea 100644 --- a/docs/source/siteadmin/deploying.rst +++ b/docs/source/siteadmin/deploying.rst @@ -244,7 +244,7 @@ This concludes the initial configuration of the development environment. In the future, when you update your codebase, you should also run:: - ./bin/python setup.py develop --upgrade && ./bin/gmg dbupdate && git submodule fetch + ./bin/python setup.py develop --upgrade && ./bin/gmg dbupdate && git submodule update Note: If you are running an active site, depending on your server configuration, you may need to stop it first or the dbupdate command diff --git a/mediagoblin.ini b/mediagoblin.ini index fe9d5cd2..4f94b6e4 100644 --- a/mediagoblin.ini +++ b/mediagoblin.ini @@ -35,6 +35,7 @@ allow_reporting = true ## If you want the terms of service displayed, you can uncomment this # show_tos = true +user_privilege_scheme = "uploader,commenter,reporter" [storage:queuestore] base_dir = %(here)s/user_dev/media/queue diff --git a/mediagoblin/auth/__init__.py b/mediagoblin/auth/__init__.py index be5d0eed..f518a09d 100644 --- a/mediagoblin/auth/__init__.py +++ b/mediagoblin/auth/__init__.py @@ -25,7 +25,6 @@ def create_user(register_form): results = hook_runall("auth_create_user", register_form) return results[0] - def extra_validation(register_form): from mediagoblin.auth.tools import basic_extra_validation diff --git a/mediagoblin/auth/tools.py b/mediagoblin/auth/tools.py index 88716e1c..39df85af 100644 --- a/mediagoblin/auth/tools.py +++ b/mediagoblin/auth/tools.py @@ -132,11 +132,7 @@ def register_user(request, register_form): user = auth.create_user(register_form) # give the user the default privileges - default_privileges = [ - Privilege.query.filter(Privilege.privilege_name==u'commenter').first(), - Privilege.query.filter(Privilege.privilege_name==u'uploader').first(), - Privilege.query.filter(Privilege.privilege_name==u'reporter').first()] - user.all_privileges += default_privileges + user.all_privileges += get_default_privileges(user) user.save() # log the user in @@ -151,6 +147,14 @@ def register_user(request, register_form): return None +def get_default_privileges(user): + instance_privilege_scheme = mg_globals.app_config['user_privilege_scheme'] + default_privileges = [Privilege.query.filter( + Privilege.privilege_name==privilege_name).first() + for privilege_name in instance_privilege_scheme.split(',')] + default_privileges = [privilege for privilege in default_privileges if not privilege == None] + + return default_privileges def check_login_simple(username, password): user = auth.get_user(username=username) diff --git a/mediagoblin/config_spec.ini b/mediagoblin/config_spec.ini index cc1ac637..ba2b4519 100644 --- a/mediagoblin/config_spec.ini +++ b/mediagoblin/config_spec.ini @@ -89,6 +89,9 @@ upload_limit = integer(default=None) # Max file size (in Mb) max_file_size = integer(default=None) +# Privilege scheme +user_privilege_scheme = string(default="uploader,commenter,reporter") + [jinja2] # Jinja2 supports more directives than the minimum required by mediagoblin. # This setting allows users creating custom templates to specify a list of diff --git a/mediagoblin/db/migrations.py b/mediagoblin/db/migrations.py index 17f8bef4..c94fbda0 100644 --- a/mediagoblin/db/migrations.py +++ b/mediagoblin/db/migrations.py @@ -31,6 +31,7 @@ from mediagoblin.db.migration_tools import ( RegisterMigration, inspect_table, replace_table_hack) from mediagoblin.db.models import (MediaEntry, Collection, MediaComment, User, Privilege) +from mediagoblin.db.extratypes import JSONEncoded, MutationDict MIGRATIONS = {} @@ -707,6 +708,7 @@ def create_moderation_tables(db): is_admin.drop() db.commit() + @RegisterMigration(19, MIGRATIONS) def drop_MediaEntry_collected(db): """ @@ -721,6 +723,20 @@ def drop_MediaEntry_collected(db): db.commit() + +@RegisterMigration(20, MIGRATIONS) +def add_metadata_column(db): + metadata = MetaData(bind=db.bind) + + media_entry = inspect_table(metadata, 'core__media_entries') + + col = Column('media_metadata', MutationDict.as_mutable(JSONEncoded), + default=MutationDict()) + col.create(media_entry) + + db.commit() + + class PrivilegeUserAssociation_R1(declarative_base()): __tablename__ = 'rename__privileges_users' user_id = Column( @@ -732,7 +748,8 @@ class PrivilegeUserAssociation_R1(declarative_base()): ForeignKey(Privilege.id), primary_key=True) -@RegisterMigration(20, MIGRATIONS) + +@RegisterMigration(21, MIGRATIONS) def fix_privilege_user_association_table(db): """ There was an error in the PrivilegeUserAssociation table that allowed for a diff --git a/mediagoblin/db/models.py b/mediagoblin/db/models.py index f03cf615..77bfe14e 100644 --- a/mediagoblin/db/models.py +++ b/mediagoblin/db/models.py @@ -264,6 +264,8 @@ class MediaEntry(Base, MediaEntryMixin): cascade="all, delete-orphan" ) collections = association_proxy("collections_helper", "in_collection") + media_metadata = Column(MutationDict.as_mutable(JSONEncoded), + default=MutationDict()) ## TODO # fail_error diff --git a/mediagoblin/edit/forms.py b/mediagoblin/edit/forms.py index 2c9b5e99..7c390a3f 100644 --- a/mediagoblin/edit/forms.py +++ b/mediagoblin/edit/forms.py @@ -15,10 +15,12 @@ # along with this program. If not, see <http://www.gnu.org/licenses/>. import wtforms +from jsonschema import Draft4Validator from mediagoblin.tools.text import tag_length_validator from mediagoblin.tools.translate import lazy_pass_to_ugettext as _ from mediagoblin.tools.licenses import licenses_as_choices +from mediagoblin.tools.metadata import DEFAULT_SCHEMA, DEFAULT_CHECKER from mediagoblin.auth.tools import normalize_user_or_email_field @@ -122,3 +124,38 @@ class ChangeEmailForm(wtforms.Form): [wtforms.validators.Required()], description=_( "Enter your password to prove you own this account.")) + +class MetaDataValidator(object): + """ + Custom validator which runs form data in a MetaDataForm through a jsonschema + validator and passes errors recieved in jsonschema to wtforms. + + :param schema The json schema to validate the data against. By + default this uses the DEFAULT_SCHEMA from + mediagoblin.tools.metadata. + :param format_checker The FormatChecker object that limits which types + jsonschema can recognize. By default this uses + DEFAULT_CHECKER from mediagoblin.tools.metadata. + """ + def __init__(self, schema=DEFAULT_SCHEMA, format_checker=DEFAULT_CHECKER): + self.schema = schema + self.format_checker = format_checker + + def __call__(self, form, field): + metadata_dict = {field.data:form.value.data} + validator = Draft4Validator(self.schema, + format_checker=self.format_checker) + errors = [e.message + for e in validator.iter_errors(metadata_dict)] + if len(errors) >= 1: + raise wtforms.validators.ValidationError( + errors.pop()) + +class MetaDataForm(wtforms.Form): + identifier = wtforms.TextField(_(u'Identifier'),[MetaDataValidator()]) + value = wtforms.TextField(_(u'Value')) + +class EditMetaDataForm(wtforms.Form): + media_metadata = wtforms.FieldList( + wtforms.FormField(MetaDataForm, ""), + ) diff --git a/mediagoblin/edit/views.py b/mediagoblin/edit/views.py index 80590875..e998d6be 100644 --- a/mediagoblin/edit/views.py +++ b/mediagoblin/edit/views.py @@ -17,8 +17,10 @@ from datetime import datetime from itsdangerous import BadSignature +from pyld import jsonld from werkzeug.exceptions import Forbidden from werkzeug.utils import secure_filename +from jsonschema import ValidationError, Draft4Validator from mediagoblin import messages from mediagoblin import mg_globals @@ -29,8 +31,11 @@ from mediagoblin.edit import forms from mediagoblin.edit.lib import may_edit_media from mediagoblin.decorators import (require_active_login, active_user_from_url, get_media_entry_by_id, user_may_alter_collection, - get_user_collection) + get_user_collection, user_has_privilege, + user_not_banned) from mediagoblin.tools.crypto import get_timed_signer_url +from mediagoblin.tools.metadata import (compact_and_validate, DEFAULT_CHECKER, + DEFAULT_SCHEMA) from mediagoblin.tools.mail import email_debug_message from mediagoblin.tools.response import (render_to_response, redirect, redirect_obj, render_404) @@ -432,3 +437,30 @@ def change_email(request): 'mediagoblin/edit/change_email.html', {'form': form, 'user': user}) + +@user_has_privilege(u'admin') +@require_active_login +@get_media_entry_by_id +def edit_metadata(request, media): + form = forms.EditMetaDataForm(request.form) + if request.method == "POST" and form.validate(): + metadata_dict = dict([(row['identifier'],row['value']) + for row in form.media_metadata.data]) + json_ld_metadata = None + json_ld_metadata = compact_and_validate(metadata_dict) + media.media_metadata = json_ld_metadata + media.save() + return redirect_obj(request, media) + + if len(form.media_metadata) == 0: + for identifier, value in media.media_metadata.iteritems(): + if identifier == "@context": continue + form.media_metadata.append_entry({ + 'identifier':identifier, + 'value':value}) + + return render_to_response( + request, + 'mediagoblin/edit/metadata.html', + {'form':form, + 'media':media}) diff --git a/mediagoblin/gmg_commands/__init__.py b/mediagoblin/gmg_commands/__init__.py index 9de4130e..fd546aac 100644 --- a/mediagoblin/gmg_commands/__init__.py +++ b/mediagoblin/gmg_commands/__init__.py @@ -57,6 +57,10 @@ SUBCOMMAND_MAP = { 'setup': 'mediagoblin.gmg_commands.deletemedia:parser_setup', 'func': 'mediagoblin.gmg_commands.deletemedia:deletemedia', 'help': 'Delete media entries'}, + 'batchaddmedia': { + 'setup': 'mediagoblin.gmg_commands.batchaddmedia:parser_setup', + 'func': 'mediagoblin.gmg_commands.batchaddmedia:batchaddmedia', + 'help': 'Add many media entries at once'}, # 'theme': { # 'setup': 'mediagoblin.gmg_commands.theme:theme_parser_setup', # 'func': 'mediagoblin.gmg_commands.theme:theme', diff --git a/mediagoblin/gmg_commands/batchaddmedia.py b/mediagoblin/gmg_commands/batchaddmedia.py new file mode 100644 index 00000000..b7f2569c --- /dev/null +++ b/mediagoblin/gmg_commands/batchaddmedia.py @@ -0,0 +1,193 @@ +# 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 requests +from csv import reader as csv_reader +from urlparse import urlparse + +from mediagoblin.gmg_commands import util as commands_util +from mediagoblin.submit.lib import ( + submit_media, get_upload_file_limits, + FileUploadLimit, UserUploadLimit, UserPastUploadLimit) +from mediagoblin.tools.metadata import compact_and_validate +from mediagoblin.tools.translate import pass_to_ugettext as _ +from jsonschema.exceptions import ValidationError + + +def parser_setup(subparser): + subparser.description = """\ +This command allows the administrator to upload many media files at once.""" + subparser.epilog = _(u"""For more information about how to properly run this +script (and how to format the metadata csv file), read the MediaGoblin +documentation page on command line uploading +<http://docs.mediagoblin.org/siteadmin/commandline-upload.html>""") + subparser.add_argument( + 'username', + help=_(u"Name of user these media entries belong to")) + subparser.add_argument( + 'metadata_path', + help=_( +u"""Path to the csv file containing metadata information.""")) + subparser.add_argument( + '--celery', + action='store_true', + help=_(u"Don't process eagerly, pass off to celery")) + + +def batchaddmedia(args): + # Run eagerly unless explicetly set not to + if not args.celery: + os.environ['CELERY_ALWAYS_EAGER'] = 'true' + + app = commands_util.setup_app(args) + + files_uploaded, files_attempted = 0, 0 + + # get the user + user = app.db.User.query.filter_by(username=args.username.lower()).first() + if user is None: + print _(u"Sorry, no user by username '{username}' exists".format( + username=args.username)) + return + + upload_limit, max_file_size = get_upload_file_limits(user) + temp_files = [] + + if os.path.isfile(args.metadata_path): + metadata_path = args.metadata_path + + else: + error = _(u'File at {path} not found, use -h flag for help'.format( + path=args.metadata_path)) + print error + return + + abs_metadata_filename = os.path.abspath(metadata_path) + abs_metadata_dir = os.path.dirname(abs_metadata_filename) + upload_limit, max_file_size = get_upload_file_limits(user) + + def maybe_unicodeify(some_string): + # this is kinda terrible + if some_string is None: + return None + else: + return unicode(some_string) + + with file(abs_metadata_filename, 'r') as all_metadata: + contents = all_metadata.read() + media_metadata = parse_csv_file(contents) + + for media_id, file_metadata in media_metadata.iteritems(): + files_attempted += 1 + # In case the metadata was not uploaded initialize an empty dictionary. + json_ld_metadata = compact_and_validate({}) + + # Get all metadata entries starting with 'media' as variables and then + # delete them because those are for internal use only. + original_location = file_metadata['location'] + + ### Pull the important media information for mediagoblin from the + ### metadata, if it is provided. + title = file_metadata.get('title') or file_metadata.get('dc:title') + description = (file_metadata.get('description') or + file_metadata.get('dc:description')) + + license = file_metadata.get('license') + try: + json_ld_metadata = compact_and_validate(file_metadata) + except ValidationError, exc: + error = _(u"""Error with media '{media_id}' value '{error_path}': {error_msg} +Metadata was not uploaded.""".format( + media_id=media_id, + error_path=exc.path[0], + error_msg=exc.message)) + print error + continue + + url = urlparse(original_location) + filename = url.path.split()[-1] + + if url.scheme == 'http': + res = requests.get(url.geturl(), stream=True) + media_file = res.raw + + elif url.scheme == '': + path = url.path + if os.path.isabs(path): + file_abs_path = os.path.abspath(path) + else: + file_path = os.path.join(abs_metadata_dir, path) + file_abs_path = os.path.abspath(file_path) + try: + media_file = file(file_abs_path, 'r') + except IOError: + print _(u"""\ +FAIL: Local file {filename} could not be accessed. +{filename} will not be uploaded.""".format(filename=filename)) + continue + try: + submit_media( + mg_app=app, + user=user, + submitted_file=media_file, + filename=filename, + title=maybe_unicodeify(title), + description=maybe_unicodeify(description), + license=maybe_unicodeify(license), + metadata=json_ld_metadata, + tags_string=u"", + upload_limit=upload_limit, max_file_size=max_file_size) + print _(u"""Successfully submitted {filename}! +Be sure to look at the Media Processing Panel on your website to be sure it +uploaded successfully.""".format(filename=filename)) + files_uploaded += 1 + except FileUploadLimit: + print _( +u"FAIL: This file is larger than the upload limits for this site.") + except UserUploadLimit: + print _( +"FAIL: This file will put this user past their upload limits.") + except UserPastUploadLimit: + print _("FAIL: This user is already past their upload limits.") + print _( +"{files_uploaded} out of {files_attempted} files successfully submitted".format( + files_uploaded=files_uploaded, + files_attempted=files_attempted)) + + +def parse_csv_file(file_contents): + """ + The helper function which converts the csv file into a dictionary where each + item's key is the provided value 'id' and each item's value is another + dictionary. + """ + list_of_contents = file_contents.split('\n') + key, lines = (list_of_contents[0].split(','), + list_of_contents[1:]) + objects_dict = {} + + # Build a dictionary + for index, line in enumerate(lines): + if line.isspace() or line == '': continue + values = csv_reader([line]).next() + line_dict = dict([(key[i], val) + for i, val in enumerate(values)]) + media_id = line_dict.get('id') or index + objects_dict[media_id] = (line_dict) + + return objects_dict + diff --git a/mediagoblin/media_types/video/processing.py b/mediagoblin/media_types/video/processing.py index abd5f36e..454f4ac4 100644 --- a/mediagoblin/media_types/video/processing.py +++ b/mediagoblin/media_types/video/processing.py @@ -109,7 +109,7 @@ def store_metadata(media_entry, metadata): dt.get_minute(), dt.get_second(), dt.get_microsecond()).isoformat() - metadata['tags'] = tags + stored_metadata['tags'] = tags # Only save this field if there's something to save if len(stored_metadata): diff --git a/mediagoblin/plugins/archivalook/.gitignore b/mediagoblin/plugins/archivalook/.gitignore new file mode 100644 index 00000000..51743ce8 --- /dev/null +++ b/mediagoblin/plugins/archivalook/.gitignore @@ -0,0 +1,5 @@ +*.pyc +*.pyo +*~ +*.swp +*.backup.html diff --git a/mediagoblin/plugins/archivalook/COPYING.txt b/mediagoblin/plugins/archivalook/COPYING.txt new file mode 100644 index 00000000..dba13ed2 --- /dev/null +++ b/mediagoblin/plugins/archivalook/COPYING.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<http://www.gnu.org/licenses/>. diff --git a/mediagoblin/plugins/archivalook/README.txt b/mediagoblin/plugins/archivalook/README.txt new file mode 100644 index 00000000..2cb67481 --- /dev/null +++ b/mediagoblin/plugins/archivalook/README.txt @@ -0,0 +1,55 @@ + +.&&&&&&&&&&&&&&&&&&&&&&&&&&&&. +!&& A R C H I V A L O O K &&&! +,============================, +`````````````````````````````` + +Q: What is this? +A: It's a very simple plugin for MediaGoblin <http://mediagoblin.org> + +Q: What does it do? +A: Archivalook swaps the default MediaGoblin front page (which is a gallery of +the most recent media submitted) with a new front page that is better for cura- +ted websites. Instead of showing the most recent media, archivalook shows +Featured Media on the front page. + +Q: How do I install it? +A: Check out this page for instructions: +http://mediagoblin.readthedocs.org/en/v0.6.1/siteadmin/plugins.html +Be sure to run ./bin/gmg assetlink after you have added the plugin to your +instance, this is necessary because the plugin uses custom css. + +Q: I set it up but I still can't feature media, what do I do? +A: So when you first activate this plugin, no users have the proper user +permissions to manage featured media. Below this I'll give instructions of how +to give those permissions to yourself and no one else: + + 1) If you haven't already, create a user for yourself. You can do this + one of two ways + a) you can run your website, visit it, click the link that says `Login` + (in the top right corner), and then click the link that says + `Register`. Enter your information and you now have a user account. + b) you can use the command line tool. in a terminal, navigate to your + mediagoblin directory. run the command + $ ./bin/gmg adduser + and then follow the prompts on screen. + 2) Next, you need to use the command line tool to make yourself an admin. + If you haven't already, navigate to the mediagoblin directory in a + terminal. Once there, run the command + $ ./bin/gmg makeadmin <username> + where instead of <username> you type in your actual username :P + 3) Now you're the admin! Next, you need to run your server. It's fine if + you run it locally, by just running: + $ ./lazyserver.sh + from the mediagoblin directory. Visit the website, and if you click the + downard facing arrow to the top left, you should see that you now have + access to new pages, the very useful moderation panels. Click on the one + labeled `User Moderation Panel`. + 4) You should be directed to a (possibly very short) table of users, find + your own username, and click on it. + 5) Now you see your own `User's Detail Page`. At the bottom you should see + a table of all the things your user has permission to do, including + being active, and being an administrator. You should see that you don't + have permission to feature media. Fix that by clicking the `+` button to + the right of 'Featurer'. + 6) Wooo! Now you can feature and unfeature media! diff --git a/mediagoblin/plugins/archivalook/__init__.py b/mediagoblin/plugins/archivalook/__init__.py new file mode 100644 index 00000000..3f6d9c66 --- /dev/null +++ b/mediagoblin/plugins/archivalook/__init__.py @@ -0,0 +1,106 @@ +# 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 logging +import os +from pkg_resources import resource_filename + +from mediagoblin.tools.pluginapi import (register_template_path, + register_routes, + register_template_hooks) +from mediagoblin.plugins.archivalook.views import (get_root_view, + add_featured_media_to_media_home) +from mediagoblin.tools.staticdirect import PluginStatic + + +_log = logging.getLogger(__name__) + + +_setup_plugin_called = 0 + +def setup_plugin(): + global _setup_plugin_called + + my_plugin_dir = os.path.dirname(__file__) + template_dir = os.path.join(my_plugin_dir, 'templates') + register_template_path(template_dir) + register_routes([ + ('manage-featured-media', '/mod/feature-media/', + 'mediagoblin.plugins.archivalook.views:featured_media_panel'), + ('gallery-recent-media', '/recent/', + 'mediagoblin.plugins.archivalook.views:recent_media_gallery_view'), + ('mediagoblin.user_pages.media_feature', + '/u/<string:user>/m/<string:media>/feature/', + 'mediagoblin.plugins.archivalook.views:feature_media'), + ('mediagoblin.user_pages.media_unfeature', + '/u/<string:user>/m/<string:media>/unfeature/', + 'mediagoblin.plugins.archivalook.views:unfeature_media'), + ('mediagoblin.user_pages.feature_promote', + '/u/<string:user>/m/<string:media>/promote_feature/', + 'mediagoblin.plugins.archivalook.views:promote_featured_media'), + ('mediagoblin.user_pages.feature_demote', + '/u/<string:user>/m/<string:media>/demote_feature/', + 'mediagoblin.plugins.archivalook.views:demote_featured_media')]) + register_template_hooks({ + 'media_sideinfo':'archivalook/feature_media_sidebar.html'}) + register_template_hooks({ + 'moderation_powers':'archivalook/bits/feature_dropdown.html'}) + + # Add template head hooks, if certain media types are enabled + from mediagoblin import mg_globals + plugin_section = mg_globals.global_config.get("plugins", {}) + if "mediagoblin.media_types.video" in plugin_section: + register_template_hooks({ + "archivalook_feature_head": ( + "/archivalook/feature_displays/video_head.html")}) + if "mediagoblin.media_types.audio" in plugin_section: + register_template_hooks({ + "archivalook_feature_head": ( + "/archivalook/feature_displays/audio_head.html")}) + + +IMAGE_PRIMARY_TEMPLATE = "/archivalook/feature_displays/image_primary.html" +IMAGE_SECONDARY_TEMPLATE = "/archivalook/feature_displays/image_secondary.html" +IMAGE_TERTIARY_TEMPLATE = "/archivalook/feature_displays/image_tertiary.html" +AUDIO_PRIMARY_TEMPLATE = "/archivalook/feature_displays/audio_primary.html" +AUDIO_SECONDARY_TEMPLATE = "/archivalook/feature_displays/audio_secondary.html" +AUDIO_TERTIARY_TEMPLATE = "/archivalook/feature_displays/audio_tertiary.html" +VIDEO_PRIMARY_TEMPLATE = "/archivalook/feature_displays/video_primary.html" +VIDEO_SECONDARY_TEMPLATE = "/archivalook/feature_displays/video_secondary.html" +VIDEO_TERTIARY_TEMPLATE = "/archivalook/feature_displays/video_tertiary.html" + +hooks = { + 'setup': setup_plugin, + 'static_setup': lambda: PluginStatic( + 'archivalook', + resource_filename('mediagoblin.plugins.archivalook', 'static') + ), + 'frontpage_view': get_root_view, + 'media_home_context': add_featured_media_to_media_home, + + # # Primary and secondary templates + ("feature_primary_template", + "mediagoblin.media_types.image"): lambda: IMAGE_PRIMARY_TEMPLATE, + ("feature_secondary_template", + "mediagoblin.media_types.image"): lambda: IMAGE_SECONDARY_TEMPLATE, + ("feature_primary_template", + "mediagoblin.media_types.audio"): lambda: AUDIO_PRIMARY_TEMPLATE, + ("feature_secondary_template", + "mediagoblin.media_types.audio"): lambda: AUDIO_SECONDARY_TEMPLATE, + ("feature_primary_template", + "mediagoblin.media_types.video"): lambda: VIDEO_PRIMARY_TEMPLATE, + ("feature_secondary_template", + "mediagoblin.media_types.video"): lambda: VIDEO_SECONDARY_TEMPLATE, +} diff --git a/mediagoblin/plugins/archivalook/forms.py b/mediagoblin/plugins/archivalook/forms.py new file mode 100644 index 00000000..b22a2e2f --- /dev/null +++ b/mediagoblin/plugins/archivalook/forms.py @@ -0,0 +1,21 @@ +# 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 wtforms +from mediagoblin.tools.translate import lazy_pass_to_ugettext as _ + +class FeaturedMediaList(wtforms.Form): + box_content = wtforms.TextAreaField( + _('Enter the URL for the media to be featured')) diff --git a/mediagoblin/plugins/archivalook/models.py b/mediagoblin/plugins/archivalook/models.py new file mode 100644 index 00000000..3d8dd756 --- /dev/null +++ b/mediagoblin/plugins/archivalook/models.py @@ -0,0 +1,103 @@ +# 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/>. +from sqlalchemy import Column, Integer, Unicode, ForeignKey +from sqlalchemy.orm import relationship, backref + +from mediagoblin.db.base import Base +from mediagoblin.db.models import MediaEntry, Privilege + +BACKREF_NAME = "archivalook__featured" + + +class FeaturedMedia(Base): + """ + A table which logs which media are featured so that they can be displayed on + the front page. + + :keyword media_entry_id An integer foreign key which + indicates which media entry this + feature describes. + :keyword display_type A string to describe how + prominently this feature will be + displayed. The three appropriate + values are 'primary', + 'secondary' and 'tertiary' + :keyword order An integer describing this + feature's place in the "stack" + which is displayed to the site's + visitor. This value should begin + at 0 (for the top) and increase + by one for each feature below it + + """ + __tablename__="archivalook__featured_media" + + id = Column(Integer, primary_key=True, nullable=False) + media_entry_id = Column(Integer, ForeignKey(MediaEntry.id), nullable=False) + media_entry = relationship( + MediaEntry, + backref=backref(BACKREF_NAME, uselist=False, + cascade="all, delete-orphan")) + display_type = Column(Unicode, nullable=False) + order = Column(Integer, nullable=False) + + def move_down(self): + self.order += 1 + self.save() + + def move_up(self): + if not self.order == 1: + self.order -= 1 + self.save() + + def demote(self): + if self.is_last_of_type() and self.display_type == u'primary': + self.display_type = u'secondary' + elif self.is_last_of_type() and self.display_type == u'secondary': + self.display_type = u'tertiary' + self.save() + + def promote(self): + if self.is_first_of_type() and self.display_type == u'secondary': + self.display_type = u'primary' + elif self.is_first_of_type() and self.display_type == u'tertiary': + self.display_type = u'secondary' + self.save() + + def is_first_of_type(self): + """ + :returns boolean Returns True if the feature is the first + of its display type to show up on the + front page. Returns False otherwise. + """ + return FeaturedMedia.query.order_by( + FeaturedMedia.order.asc()).filter( + FeaturedMedia.display_type==self.display_type).first() == self + + def is_last_of_type(self): + """ + :returns boolean Returns True if the feature is the last + of its display type to show up on the + front page. Returns False otherwise. + """ + return FeaturedMedia.query.order_by( + FeaturedMedia.order.desc()).filter( + FeaturedMedia.display_type==self.display_type).first() == self + +MODELS = [FeaturedMedia] + +new_privilege_foundations = [{"privilege_name":"featurer"}] +FOUNDATIONS = {Privilege:new_privilege_foundations} diff --git a/mediagoblin/plugins/archivalook/static/css/featured-media.css b/mediagoblin/plugins/archivalook/static/css/featured-media.css new file mode 100644 index 00000000..12a3ebff --- /dev/null +++ b/mediagoblin/plugins/archivalook/static/css/featured-media.css @@ -0,0 +1,154 @@ +.primary-feature { + display:inline-block; + width: 460px; + padding:10px; + margin:0px 0px 0px 160px; + border-right: 1px solid #222; + border-left: 1px solid #222; +} + +.primary-feature .f-title { + text-align:center; +} +.primary-feature .f-description { + +} +.primary-feature .f-display { + width: 300px; + margin: 5px auto; +} +.primary-feature .f-display img { + width: 300px; +} +.primary-feature .f-display video { + width: 300px; + margin: 5px auto; + display: block; +} +.primary-feature a { + text-decoration:none; + +} +.primary-feature p { + display:block; + margin: 5px auto; +} + +.secondary-feature { + display:inline-block; + width: 800px; + padding:10px; + margin: 0 auto; + font-size:85%; + border-top: 1px solid #222; +} +.secondary-feature .f-title, +.secondary-feature .f-description { + width:500px; +} +.secondary-feature .f-display { + width: 250px; + margin: 20px 25px 20px 0; +} +.secondary-feature .f-display img { + width: 200px; +} + +.secondary-feature .f-display audio { + width: 250px; + display: block; +} + +.secondary-feature .f-display video { + width: 200px; +} + +.secondary-feature a { + text-decoration:none; +} +.secondary-feature p { + display:inline-block; + margin:5px; +} + +.f-title { + color:#ffffff; + font-size:150%; +} + +.aligned-right .f-display, +.aligned-right .f-description, +.aligned-right .f-title { + float: right; +} +.aligned-left .f-display, +.aligned-left .f-description, +.aligned-left .f-title { + float: left; +} + +.tertiary-features { + display:inline-block; + width: 802px; + padding:10px; + margin: 10 auto; + font-size:65%; + border-top: 0.5px solid #222; +} + +.tertiary-features tr td { + width: 254px; + padding: 20px 15px; +} + +.tertiary-features tr td.row_first { + text-align: left; +} + +.tertiary-features tr td.row_center { + text-align: center; +} + +.tertiary-features tr td.row_last { + text-align: right; +} + +.tertiary-features tr td p, .tertiary-features tr td a, { + display:block; + width: 250px; + text-decoration:none; + float: left; +} + +div.navigation-sidebar { + display:inline-block; + float:right; + font-size:1.25em; + padding:20px 10px 10px 10px; +} +div.navigation-sidebar a { + display: block; + margin: 3px 0 0 0; +} + +select.media_select { + width: 800px; + height: 400px; +} + +.frontpage-container { + width: 800px; + margin: 0 auto; +} + +form#featured-media-panel div textarea { + width: 800px; + margin: 0 auto; + font-size:1.15em; + height: 15em; + font-weight: 0.3; + resize: none; + padding: 5px 25px; + color: #111; + line-height: 1.25em; +} diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/bits/feature_dropdown.html b/mediagoblin/plugins/archivalook/templates/archivalook/bits/feature_dropdown.html new file mode 100644 index 00000000..289bbfac --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/bits/feature_dropdown.html @@ -0,0 +1,24 @@ +{# +# 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/>. +#} + {% if request.user and + request.user.has_privilege('featurer') %} + · + <a href="{{ request.urlgen('manage-featured-media') }}"> + {%- trans %}Feature management panel{% endtrans -%} + </a> + {% endif %} diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature.html new file mode 100644 index 00000000..6bcf792e --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature.html @@ -0,0 +1,115 @@ +{# +# 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/>. +#} +{% extends "mediagoblin/base.html" %} +{% import "/mediagoblin/utils/wtforms.html" as wtforms_util %} + +{%- block mediagoblin_head -%} + <link rel="stylesheet" type="text/css" + href="{{ request.staticdirect('css/featured-media.css','archivalook') }}"/> +{%- endblock mediagoblin_head %} + +{%- block mediagoblin_content %} + <form method="POST" action="" id="featured-media-panel"> + {{ wtforms_util.render_divs(form) }} + <input type=submit /> + {{ csrf_token }} + </form> + + <h2>{% trans %}How does this work?{% endtrans %}</h2> + <strong><a class="highlight">{% trans %}How to feature media?{% endtrans -%} + </a></strong> + <p> + {% trans %} + Go to the page of the media entry you want to feature. Copy it's URL and + then paste it into a new line in the text box above. There should be only + one url per line. The url that you paste into the text box should be under + the header describing how prominent a feature it will be (whether Primary, + Secondary, or Tertiary). Once all of the media that you want to feature are + inside the text box, click the Submit Query button, and your media should be + displayed on the front page. + {% endtrans %}</p> + + <strong><a class="highlight"> + {%- trans %}Is there another way to manage featured media?{% endtrans %} + </a></strong> + <p> + {% trans %} + Yes. If you would prefer, you may go to the media homepage of the piece + of media you would like to feature or unfeature and look at the bar to + the side of the media entry. If the piece of media has not been featured + yet you should see a button that says 'Feature'. Press that button and + the media will be featured as a Primary Feature at the top of the page. + All other featured media entries will remain as features, but will be + pushed further down the page.<br /><br /> + + If you go to the media homepage of a piece of media that is currently + featured, you will see the options "Unfeature", "Promote" and "Demote" + where previously there was the button which said "Feature". Click + Unfeature and that media entry will no longer be displayed on the + front page, although you can feature it again at any point. Promote + moves the featured media higher up on the page and makes it more + prominent and Demote moves the featured media lower down and makes it + less prominent. + {% endtrans %}</p> + + <strong><a class="highlight">{% trans -%} + What is a Primary Feature? What is a Secondary Feature?{% endtrans -%} + </a></strong> + <p> + {% trans %} + These categories just describe how prominent a feature will be on your + front page. Primary Features are placed at the top of the front page and are + much larger. Next are Secondary Features, which are slightly smaller. + Tertiary Features make up a grid at the bottom of the page.<br /><br /> + + Primary Features also can display longer descriptions than Secondary + Features, and Secondary Features can display longer descriptions than + Tertiary Features.{% endtrans %}</p> + + <strong><a class="highlight"> + {% trans %}How to decide what information is displayed when a media entry is + featured?{% endtrans %}</a></strong> + <p> + {% trans %} + When a media entry is featured, the entry's title, it's thumbnail and a + portion of its description will be displayed on your website's front page. + The number of characters displayed varies on the prominence of the feature. + Primary Features display the first 512 characters of their description, + Secondary Features display the first 256 characters of their description, + and Tertiary Features display the first 128 characters of their description. + {% endtrans %} + </p> + + <strong><a class="highlight">{% trans -%} + How to unfeature a piece of media?{% endtrans -%} + </a></strong> + <p> + {% trans %} + Unfeature a media by removing its line from the above textarea and then + pressing the Submit Query button. + {% endtrans %} + </p> + + <strong><a class="highlight">{% trans %}CAUTION:{% endtrans %}</a></strong> + <p> + {% trans %} + When copying and pasting urls into the above text box, be aware that if + you make a typo, once you press Submit Query, your media entry will NOT be + featured. Make sure that all your intended Media Entries are featured. + {% endtrans %}</p> +{% endblock %} diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/audio_head.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/audio_head.html new file mode 100644 index 00000000..a53694b3 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/audio_head.html @@ -0,0 +1,5 @@ + <link rel="stylesheet" type="text/css" href="{{ request.staticdirect('/css/audio.css') }}" /> + <script type="text/javascript" src="{{ request.staticdirect( + '/js/extlib/html5slider.js') }}"></script> + <script type="text/javascript" src="{{ request.staticdirect( + '/js/audio.js') }}"></script> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/audio_primary.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/audio_primary.html new file mode 100644 index 00000000..aae3790d --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/audio_primary.html @@ -0,0 +1,54 @@ +{# +# 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/>. +#} + +{% from "archivalook/utils/display_featured.html" import + possibly_shortened_description %} + +{%- set media = feature.media_entry %} +{%- set entry_url = media.url_for_self(request.urlgen) %} + +<div class="primary-feature"> + <a href="{{ entry_url }}"> + <p class="f-title">{{ media.title }}</p> + </a> + <p> + <div class="audio-media"> + {%- if 'spectrogram' in media.media_files %} + <div class="audio-spectrogram f-display"> + <img src="{{ request.app.public_store.file_url( + media.media_files.spectrogram) }}" + alt="Spectrogram" /> + </div> + {%- endif %} + <audio class="audio-player" controls="controls" + preload="metadata"> + <source src="{{ request.app.public_store.file_url( + media.media_files.webm_audio) }}" type="audio/webm; codecs=vorbis" /> + <div class="no_html5"> + {%- trans -%}Sorry, this audio will not work because + your web browser does not support HTML5 + audio.{%- endtrans -%}<br/> + {%- trans -%}You can get a modern web browser that + can play the audio at <a href="http://getfirefox.com"> + http://getfirefox.com</a>!{%- endtrans -%} + </div> + </audio> + </div> + </p> + {{ possibly_shortened_description(request, feature.media_entry) }} +</div> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/audio_secondary.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/audio_secondary.html new file mode 100644 index 00000000..b863f5b0 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/audio_secondary.html @@ -0,0 +1,40 @@ +{# +# 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/>. +#} + +{% from "archivalook/utils/display_featured.html" import + possibly_shortened_description %} + +{%- set media = feature.media_entry %} +{%- set entry_url = media.url_for_self(request.urlgen) %} +{%- if feature_loop.index % 2 == 1 -%} +<div class="secondary-feature aligned-right"> +{%- else -%} +<div class="secondary-feature aligned-left"> +{%- endif %} + <p class="f-display"> + <audio class="audio-player" controls="controls" + preload="metadata"> + <source src="{{ request.app.public_store.file_url( + media.media_files.webm_audio) }}" type="audio/webm; codecs=vorbis" /> + </audio> + </p> + {{ possibly_shortened_description(request, feature.media_entry) }} + <a href="{{ entry_url }}"> + <p class="f-title">{{ media.title }}</p> + </a> +</div> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/default_primary.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/default_primary.html new file mode 100644 index 00000000..57986622 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/default_primary.html @@ -0,0 +1,30 @@ +{# +# 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/>. +#} + +{% from "archivalook/utils/display_featured.html" import + possibly_shortened_description %} + +{%- set featured_media_entry = feature.media_entry %} +{%- set entry_url = featured_media_entry.url_for_self(request.urlgen) %} + +<div class="primary-feature"> + <a href="{{ entry_url }}"> + <p class="f-title">{{ featured_media_entry.title }}<p> + </a> + {{ possibly_shortened_description(request, feature.media_entry) }} +</div> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/default_secondary.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/default_secondary.html new file mode 100644 index 00000000..4d2bdab9 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/default_secondary.html @@ -0,0 +1,34 @@ +{# +# 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/>. +#} + + +{% from "archivalook/utils/display_featured.html" import + possibly_shortened_description %} + +{%- set featured_media_entry = feature.media_entry %} +{%- set entry_url = featured_media_entry.url_for_self(request.urlgen) %} +{%- if feature_loop.index % 2 == 1 -%} +<div class="secondary-feature aligned-right"> +{%- else -%} +<div class="secondary-feature aligned-left"> +{%- endif -%} + {{ possibly_shortened_description(request, feature.media_entry) }} + <a href="{{ entry_url }}"> + <p class="f-title">{{ featured_media_entry.title }}</p> + </a> +</div> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/default_tertiary.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/default_tertiary.html new file mode 100644 index 00000000..90083a91 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/default_tertiary.html @@ -0,0 +1,40 @@ +{# +# 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/>. +#} + +{%- from "archivalook/utils/display_featured.html" import + possibly_shortened_description -%} + +{%- set entry = feature.media_entry -%} +{%- set entry_url = entry.url_for_self(request.urlgen) -%} + +{%- if feature_loop.first %} + {%- set row_position = "row_first" %} +{%- elif feature_loop.last %} + {%- set row_position = "row_last" %} +{%- else -%} + {%- set row_position = "row_center" %} +{%- endif -%} + +<td class="{{ row_position }}"> + <a href="{{ entry_url }}"> + <img src="{{ entry.thumb_url }}" /> + </a><span class="clear"></span> + <a class="f-title" href="{{ entry_url }}">{{ entry.title }} + </a><span class="clear"></span> + {{ possibly_shortened_description(request, feature.media_entry, 128) }} +</td> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/image_primary.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/image_primary.html new file mode 100644 index 00000000..66687be9 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/image_primary.html @@ -0,0 +1,33 @@ +{# +# 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/>. +#} + +{% from "archivalook/utils/display_featured.html" import + possibly_shortened_description %} + +{%- set featured_media_entry = feature.media_entry %} +{%- set display_media = request.app.public_store.file_url( + featured_media_entry.get_display_media()[1]) %} +{%- set entry_url = featured_media_entry.url_for_self(request.urlgen) %} + +<div class="primary-feature"> + <a href="{{ entry_url }}"> + <p class="f-title">{{ featured_media_entry.title }}<p> + <p class="f-display"><img src="{{ display_media }}"/></p> + </a> + {{ possibly_shortened_description(request, feature.media_entry) }} +</div> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/image_secondary.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/image_secondary.html new file mode 100644 index 00000000..0f64448a --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/image_secondary.html @@ -0,0 +1,39 @@ +{# +# 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/>. +#} + + +{% from "archivalook/utils/display_featured.html" import + possibly_shortened_description %} + +{%- set featured_media_entry = feature.media_entry %} +{%- set display_media = request.app.public_store.file_url( + featured_media_entry.get_display_media()[1]) %} +{%- set entry_url = featured_media_entry.url_for_self(request.urlgen) %} +{%- if feature_loop.index % 2 == 1 -%} +<div class="secondary-feature aligned-right"> +{%- else -%} +<div class="secondary-feature aligned-left"> +{%- endif -%} + <a href="{{ entry_url }}"> + <p class="f-display"><img src="{{ display_media }}"/></p> + </a> + {{ possibly_shortened_description(request, feature.media_entry) }} + <a href="{{ featured_media_entry.url_for_self(request.urlgen) }}"> + <p class="f-title">{{ featured_media_entry.title }}</p> + </a> +</div> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/video_head.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/video_head.html new file mode 100644 index 00000000..495382f5 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/video_head.html @@ -0,0 +1,23 @@ +<script type="text/javascript" src="{{ + request.staticdirect('/extlib/video-js/video.js') }}"></script> +{# Sadly commented out till we can get the mediagoblin skin ported over + # to the newest video.js release ;\ #} +{# + <link href="{{ request.staticdirect('/css/vjs-mg-skin.css') }}" + rel="stylesheet"> +#} +<link href="{{ + request.staticdirect('/extlib/video-js/video-js.css') }}" + rel="stylesheet"> + +<style type="text/css"> + .vjs-default-skin .vjs-big-play-button + { + top: 50%; + left: 50%; + margin: -1.5em auto auto -2em; + } + .vjs-play-progress, .vjs-volume-level { + background-color: #86D4B1 !important; + } +</style> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/video_primary.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/video_primary.html new file mode 100644 index 00000000..64976257 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/video_primary.html @@ -0,0 +1,53 @@ +{# +# 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/>. +#} + +{% from "archivalook/utils/display_featured.html" import + possibly_shortened_description %} + +{%- set media = feature.media_entry %} +{%- set display_media = request.app.public_store.file_url( + media.get_display_media()[1]) %} +{%- set entry_url = media.url_for_self(request.urlgen) %} + +<div class="primary-feature"> + <a href="{{ entry_url }}"> + <p class="f-title">{{ media.title }}</p> + </a> + <div class="f-display"> + {%- set display_type, display_path = media.get_display_media() %} + <video controls + {% if global_config['plugins']['mediagoblin.media_types.video']['auto_play'] %}autoplay{% endif %} + preload="auto" class="video-js vjs-default-skin"> + <source src="{{ request.app.public_store.file_url(display_path) }}" + {% if media.media_data %} + type="{{ media.media_data.source_type() }}" + {% else %} + type="{{ media.media_manager['default_webm_type'] }}" + {% endif %} /> + <div class="no_html5"> + {%- trans -%}Sorry, this video will not work because + your web browser does not support HTML5 + video.{%- endtrans -%}<br/> + {%- trans -%}You can get a modern web browser that + can play this video at <a href="http://getfirefox.com"> + http://getfirefox.com</a>!{%- endtrans -%} + </div> + </video> + </div> + {{ possibly_shortened_description(request, feature.media_entry) }} +</div> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/video_secondary.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/video_secondary.html new file mode 100644 index 00000000..92a44d49 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_displays/video_secondary.html @@ -0,0 +1,56 @@ +{# +# 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/>. +#} + +{% from "archivalook/utils/display_featured.html" import + possibly_shortened_description %} + +{%- set media = feature.media_entry %} +{%- set display_media = request.app.public_store.file_url( + media.get_display_media()[1]) %} +{%- set entry_url = media.url_for_self(request.urlgen) %} +{%- if feature_loop.index % 2 == 1 -%} +<div class="secondary-feature aligned-right"> +{%- else -%} +<div class="secondary-feature aligned-left"> +{%- endif %} + <div class="f-display"> + {%- set display_type, display_path = media.get_display_media() %} + <video controls + {% if global_config['plugins']['mediagoblin.media_types.video']['auto_play'] %}autoplay{% endif %} + preload="auto" class="video-js vjs-default-skin"> + <source src="{{ request.app.public_store.file_url(display_path) }}" + {% if media.media_data %} + type="{{ media.media_data.source_type() }}" + {% else %} + type="{{ media.media_manager['default_webm_type'] }}" + {% endif %} /> + <div class="no_html5"> + {%- trans -%}Sorry, this video will not work because + your web browser does not support HTML5 + video.{%- endtrans -%}<br/> + {%- trans -%}You can get a modern web browser that + can play this video at <a href="http://getfirefox.com"> + http://getfirefox.com</a>!{%- endtrans -%} + </div> + </video> + </div> + {{ possibly_shortened_description(request, feature.media_entry) }} + <a href="{{ entry_url }}"> + <p class="f-title">{{ media.title }}</p> + </a> +</div> diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/feature_media_sidebar.html b/mediagoblin/plugins/archivalook/templates/archivalook/feature_media_sidebar.html new file mode 100644 index 00000000..c5b8a7d6 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/feature_media_sidebar.html @@ -0,0 +1,55 @@ +{# +# 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/>. +#} + {% if request.user and request.user.has_privilege('featurer') %} + {% set media_feature=featured_media.filter_by( + media_entry_id = media.id).first() %} + {% if not media_feature %} + <a href="{{ request.urlgen( + 'mediagoblin.user_pages.media_feature', + user=media.get_uploader.username, + media=media.slug_or_id) }}" + class="button_action" id="button_featuremedia" title="{% trans %} +Feature Media {% endtrans %}"> + {% trans %}Feature{% endtrans %}</a> + {% else %} + <a href="{{ request.urlgen( + 'mediagoblin.user_pages.media_unfeature', + user=media.get_uploader.username, + media=media.slug_or_id) }}" + class="button_action" id="button_unfeaturemedia" title="{% trans %} +Unfeature Media {% endtrans %}"> + {% trans %}Unfeature{% endtrans %}</a> + {% if not media_feature.display_type == 'primary' %} + <a href="{{ request.urlgen( + 'mediagoblin.user_pages.feature_promote', + user=media.get_uploader.username, + media=media.slug_or_id) }}" + class="button_action" id="button_promotefeature" title="{% trans %} +Promote Feature {% endtrans %}"> + {% trans %}Promote{% endtrans %}</a> + {% endif %}{% if not media_feature.display_type == 'tertiary' %} + <a href="{{ request.urlgen( + 'mediagoblin.user_pages.feature_demote', + user=media.get_uploader.username, + media=media.slug_or_id) }}" + class="button_action" id="button_demotefeature" title="{% trans %} +Demote Feature {% endtrans %}"> + {% trans %}Demote{% endtrans %}</a> + {% endif %} + {% endif %} + {% endif %} diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/recent_media.html b/mediagoblin/plugins/archivalook/templates/archivalook/recent_media.html new file mode 100644 index 00000000..09690c8f --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/recent_media.html @@ -0,0 +1,36 @@ +{# +# 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/>. +#} +{% extends "mediagoblin/base.html" %} + +{% from "mediagoblin/utils/object_gallery.html" import object_gallery %} + +{% set feed_url = request.urlgen('mediagoblin.listings.atom_feed') %} + +{% block mediagoblin_head -%} + {% set feed_url = request.urlgen('mediagoblin.listings.atom_feed') -%} + <link rel="alternate" type="application/atom+xml" href="{{ feed_url }}"> +{%- endblock mediagoblin_head %} + +{% block mediagoblin_content %} + <h2>{% trans %}Most recent media{% endtrans %}</h2> + {{ object_gallery(request, media_entries, pagination) }} + + {#- Need to set feed_url within this block so template can use it. -#} + {%- set feed_url = feed_url -%} + {%- include "mediagoblin/utils/feed_link.html" -%} +{% endblock %} diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/root.html b/mediagoblin/plugins/archivalook/templates/archivalook/root.html new file mode 100644 index 00000000..72fe8656 --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/root.html @@ -0,0 +1,79 @@ +{# +# 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/>. +#} +{% extends "mediagoblin/base.html" %} + +{% set feed_url = request.urlgen('mediagoblin.listings.atom_feed') %} + +{%- block mediagoblin_head -%} + {%- set feed_url = request.urlgen('mediagoblin.listings.atom_feed') %} + <link rel="alternate" type="application/atom+xml" href="{{ feed_url }}" /> + <link rel="stylesheet" type="text/css" + href="{{ request.staticdirect('css/featured-media.css','archivalook') }}"/> + + {% template_hook("archivalook_feature_head") %} +{%- endblock mediagoblin_head %} + +{%- block mediagoblin_content %} + <div class="frontpage-container" > + {%- if featured_media.primary|length > 0 or + featured_media.secondary|length > 0 or + featured_media.tertiary|length > 0 -%} + {%- for feature in featured_media.primary %} + {% set feature_loop = loop %} + {% include feature_template(feature.media_entry, "primary") %} + {%- endfor %} + + {%- for feature in featured_media.secondary %} + {% set feature_loop = loop %} + {% include feature_template(feature.media_entry, "secondary") %} + {%- endfor %} + + <table class="tertiary-features"> + {% set col_number = 3 %} + {%- for row in featured_media.tertiary|batch(col_number) %} + {% set row_loop = loop %} + <tr> + {%- for feature in row %} + {% set feature_loop = loop %} + {% include feature_template(feature.media_entry, "tertiary") %} + {%- endfor %} + </tr> + {%- endfor %} + </table> + </div> + {%- elif request.user and request.user.has_privilege('featurer') %} + <div> + <h2>{% trans %}Nothing is currently featured.{% endtrans %}</h2> + {% trans %}If you would like to feature a + piece of media, go to that media entry's homepage and click the button + that says{% endtrans %} <a class="button_action">Feature</a>. + {% trans %}You're seeing this page because you are a user capable of + featuring media, a regular user would see a blank page, so be sure to + have media featured as long as your instance has the 'archivalook' + plugin enabled. A more advanced tool to manage features can be found + in the{% endtrans %} + <a href="{{ request.urlgen( + 'manage-featured-media') }}"> + {% trans %}feature management panel.{% endtrans %}</a> + </div> + </div> + {%- endif %} + <a href="{{ request.urlgen('gallery-recent-media') }}"> + {% trans %}View most recent media{% endtrans %} + </a> +{% endblock %} diff --git a/mediagoblin/plugins/archivalook/templates/archivalook/utils/display_featured.html b/mediagoblin/plugins/archivalook/templates/archivalook/utils/display_featured.html new file mode 100644 index 00000000..b3c23c0c --- /dev/null +++ b/mediagoblin/plugins/archivalook/templates/archivalook/utils/display_featured.html @@ -0,0 +1,28 @@ +{# +# 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/>. +#} + +{% macro possibly_shortened_description(request, entry, max_length=512) -%} + <p class="f-description"> + {%- if entry.description|length < max_length %} + {{- entry.description -}} + {%- else -%} + {{- entry.description[:max_length] }}... + <a href="{{ entry.url_for_self(request.urlgen) }}">[More]</a> + {%- endif -%} + </p> +{%- endmacro %} diff --git a/mediagoblin/plugins/archivalook/tools.py b/mediagoblin/plugins/archivalook/tools.py new file mode 100644 index 00000000..9c715c9b --- /dev/null +++ b/mediagoblin/plugins/archivalook/tools.py @@ -0,0 +1,292 @@ +# 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/>. +from mediagoblin.db.models import MediaEntry, User +from mediagoblin.plugins.archivalook.models import FeaturedMedia +from mediagoblin.tools.translate import lazy_pass_to_ugettext as _ +from mediagoblin.plugins.archivalook.models import FeaturedMedia + +def get_media_entry_from_uploader_slug(uploader_username, slug): + """ + Accepts two strings and searches to see if those strings identify a + MediaEntry + + :param uploader_username A string representing the User.username + of the user who uploaded a piece of + media. + :param slug A string representing the slug of a + piece of media + + :returns media A MediaEntry object or None if no entry + matches the specifications. + """ + uploader = User.query.filter( + User.username == uploader_username).first() + media = MediaEntry.query.filter( + MediaEntry.get_uploader == uploader ).filter( + MediaEntry.slug == slug).first() + return media + + +def parse_url(url): + """ + A simple helper function that extracts the uploader and slug from a full url + + :param url A string containing the url for a piece + of media. This should be in the format + of "/u/{user}/m/{media}/" + + :returns (uploader_username, slug) Uploader_username is a unicode string + representing the username of the user + who uploaded the piece of media, slug is + the media entry's url slug. + """ + url = unicode(url) + u_end, m_start, m_end, end = (url.find('/u/') + 3, + url.find('/m/'), + url.find('/m/') + 3, + url.rfind('/')) + + uploader_username = url[u_end:m_start].strip() + slug = url[m_end:end].strip() + + return uploader_username, slug + + +def split_featured_media_list(featured_media): + """ + This script is part of processing post request on the /mod/feature-media/ + page. Post requests on these pages will only include the textbox, so this + script accepts the textbox's contents as its parameter. + + :parameter featured_media A string from a submitted + textarea within the post request + on /mod/feature-media/ + + :returns all_featured_media A dictionary of the format + MediaEntry : 'string' + where MediaEntry is a featured + piece of media and 'string' is + a string representation of its + display type (primary, secondary + or tertiary) + """ + + featured_media = unicode(featured_media) + featured_media_list = featured_media.split("\n") + display_type = 0 + media_already_featured = [] + all_featured_media = [] + for line in featured_media_list: + if line == '' or line.isspace(): continue + elif line.startswith(u'-'): + display_type += 1 + elif display_type <= 0 or display_type > 3: continue + else: + uploader, slug = parse_url(line) + media = get_media_entry_from_uploader_slug(uploader, slug) + # Make sure the media entry referenced exists, and has not already + # been featured higher up the list + if media == None or media in media_already_featured: continue + media_already_featured.append(media) + all_featured_media.append((media, + [None, + u'primary', + u'secondary', + u'tertiary'][display_type])) + + return all_featured_media + + +def create_featured_media_textbox(): + """ + This script searches through the database of which media is featured and + returns a string of each entry in the proper format for use in the + /mod/feature-media/ page. This string will be used as the default text in + the textbox on that page. + """ + + primaries = FeaturedMedia.query.order_by( + FeaturedMedia.order.asc()).filter( + FeaturedMedia.display_type == u'primary').all() + secondaries = FeaturedMedia.query.order_by( + FeaturedMedia.order.asc()).filter( + FeaturedMedia.display_type == u'secondary').all() + tertiaries = FeaturedMedia.query.order_by( + FeaturedMedia.order.asc()).filter( + FeaturedMedia.display_type == u'tertiary').all() + output_text = u'' + for display_type, feature_list in [ + (_(u'Primary'),primaries), + (_(u'Secondary'),secondaries), + (_(u'Tertiary'),tertiaries)]: + output_text += _( + u"""-----------{display_type}-Features--------------------------- +""").format(display_type=display_type) + for feature in feature_list: + media_entry = feature.media_entry + output_text += u'/u/{uploader_username}/m/{media_slug}/\n'.format( + uploader_username = media_entry.get_uploader.username, + media_slug = media_entry.slug) + + + return output_text + +def automatically_add_new_feature(media_entry): + """ + This function automates the addition of a new feature. New features will be + placed at the top of the feature stack as 'primary' features. All of the + current features are demoted one step to make room. + + :param media_entry :type mediagoblin.db.MediaEntry + The media entry that will been + featured which this function + targets + """ + # Set variables to determine which media entries should be pushed down to + # maintain the correct number of primary & secondary featured media. At this + # point the program assumes that there should be 1 primary feature and 2 + # secondary features, but in the future this should be a variable editable + # by the site admin. + too_many_primaries = FeaturedMedia.query.filter( + FeaturedMedia.display_type==u'primary').count() >= 1 + too_many_secondaries = FeaturedMedia.query.filter( + FeaturedMedia.display_type==u'secondary').count() >= 2 + featured_first_to_last = FeaturedMedia.query.order_by( + FeaturedMedia.order.asc()).all() + + for feature in featured_first_to_last: + # Some features have the option to demote or promote themselves to a + # different display_type, based on their position. But all features move + # up and down one step in the stack. + if (feature.is_last_of_type() and feature.display_type == u'primary' + and too_many_primaries): + feature.demote() + too_many_primaries = False + elif (feature.is_last_of_type() and feature.display_type == u'secondary' + and too_many_secondaries): + feature.demote() + too_many_secondaries = False + feature.move_down() + feature.save() + + # Create the new feature at the top of the stack. + new_feature = FeaturedMedia( + media_entry=media_entry, + display_type=u"primary", + order=0) + new_feature.save() + return new_feature + +def automatically_remove_feature(media_entry): + """ + This function automates the removal of a feature. All of the features below + them are promoted one step to close the gap. + + :param media_entry :type mediagoblin.db.MediaEntry + The media entry that will been + removed which this function + targets + """ + # Get the feature which will be deleted + target_feature = FeaturedMedia.query.filter( + FeaturedMedia.media_entry_id == media_entry.id).first() + # Find out which continuing features will have to be adjusted + featured_last_to_first = FeaturedMedia.query.filter( + FeaturedMedia.order>target_feature.order).order_by( + FeaturedMedia.order.desc()).all() + + for feature in featured_last_to_first: + # Maintain the current arrangement of primary/secondary/tertiary + # features by moving all the features below the deleted one up on slot + # and promoting any features in the proper position. + if feature.is_first_of_type(): + feature.promote() + feature.move_up() + feature.save() + + # Delete the feature, now that it's space has been closed + target_feature.delete() + +def promote_feature(media_entry): + """ + This function takes a current feature and moves it up the stack so that it + will be displayed higher up. It swaps the place of the selected feature for + the one above it, or if relevant raises the display_type of the feature up + one rung (ie. from 'tertiary' to 'secondary') + + :param media_entry :type mediagoblin.db.MediaEntry + The media entry that has been + featured which this function + targets + """ + # Get the FeaturedMedia object + target_feature = FeaturedMedia.query.filter( + FeaturedMedia.media_entry_id == media_entry.id).first() + # Get the first Feature with a lower order than the target + above_feature = FeaturedMedia.query.filter( + FeaturedMedia.order < target_feature.order).order_by( + FeaturedMedia.order.desc()).first() + # If the feature is not the uppermost one + if above_feature is not None: + # Swap the positions of the target feature with the one before it + (target_feature.order, + above_feature.order) = above_feature.order, target_feature.order + (target_feature.display_type, + above_feature.display_type) = (above_feature.display_type, + target_feature.display_type) + above_feature.save() + # Change the feature's display type to a more prominent one + elif target_feature.display_type == u'secondary': + target_feature.display_type = u'primary' + elif target_feature.display_type == u'tertiary': + target_feature.display_type = u'secondary' + target_feature.save() + +def demote_feature(media_entry): + """ + This function takes a current feature and moves it down the stack so that it + will be displayed lower down. It swaps the place of the selected feature for + the one below it, or if relevant lowers the display_type of the feature down + one rung (ie. from 'secondary' to 'tertiary') + + :param media_entry :type mediagoblin.db.MediaEntry + The media entry that has been + featured which this function + targets + """ + # Get the FeaturedMedia object + target_feature = FeaturedMedia.query.filter( + FeaturedMedia.media_entry_id == media_entry.id).first() + # Get the first Feature with a higher order than the target + below_feature = FeaturedMedia.query.filter( + FeaturedMedia.order > target_feature.order).order_by( + FeaturedMedia.order.asc()).first() + # If the feature is not the lowest one + if below_feature != None: + # Swap the positions of the target feature with the one after it + (target_feature.order, + below_feature.order) = below_feature.order, target_feature.order + (target_feature.display_type, + below_feature.display_type) = (below_feature.display_type, + target_feature.display_type) + below_feature.save() + # Change the feature's display type to a less prominent one + elif target_feature.display_type == u'secondary': + target_feature.display_type = u'tertiary' + elif target_feature.display_type == u'primary': + target_feature.display_type = u'secondary' + target_feature.save() + diff --git a/mediagoblin/plugins/archivalook/utils.py b/mediagoblin/plugins/archivalook/utils.py new file mode 100644 index 00000000..a4b57bc1 --- /dev/null +++ b/mediagoblin/plugins/archivalook/utils.py @@ -0,0 +1,29 @@ +# 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/>. +from mediagoblin.tools.pluginapi import hook_handle + + +def feature_template(media, feature_type): + """ + Get the feature template for this media + """ + template_name = hook_handle( + ("feature_%s_template" % feature_type, media.media_type)) + + if template_name is None: + return "/archivalook/feature_displays/default_%s.html" % feature_type + + return template_name diff --git a/mediagoblin/plugins/archivalook/views.py b/mediagoblin/plugins/archivalook/views.py new file mode 100644 index 00000000..72424cfc --- /dev/null +++ b/mediagoblin/plugins/archivalook/views.py @@ -0,0 +1,173 @@ +# 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/>. +from mediagoblin import mg_globals +from mediagoblin.db.base import Session +from mediagoblin.db.models import MediaEntry +from mediagoblin.decorators import uses_pagination, user_not_banned,\ + user_has_privilege, get_user_media_entry +from mediagoblin.tools.response import render_to_response, redirect +from mediagoblin.tools.pagination import Pagination + +from mediagoblin.plugins.archivalook.tools import ( + split_featured_media_list, + create_featured_media_textbox, + automatically_add_new_feature, + automatically_remove_feature) +from mediagoblin.plugins.archivalook import forms as archivalook_forms +from mediagoblin.plugins.archivalook.models import FeaturedMedia +from mediagoblin.plugins.archivalook.utils import feature_template +from mediagoblin.plugins.archivalook.tools import (promote_feature, + demote_feature) +from mediagoblin.tools.translate import lazy_pass_to_ugettext as _ + +@user_not_banned +def root_view(request): + """ + This is an alternative to the typical root view. This display centers around + displaying featured media. + """ + featured_media = { + u'primary':FeaturedMedia.query.order_by( + FeaturedMedia.order.asc()).filter( + FeaturedMedia.display_type==u'primary').all(), + u'secondary':FeaturedMedia.query.order_by( + FeaturedMedia.order.asc()).filter( + FeaturedMedia.display_type==u'secondary').all(), + u'tertiary':FeaturedMedia.query.order_by( + FeaturedMedia.order.asc()).filter( + FeaturedMedia.display_type==u'tertiary').all()} + + return render_to_response( + request, 'archivalook/root.html', + {'featured_media': featured_media, + 'allow_registration': mg_globals.app_config["allow_registration"], + 'feature_template': feature_template}) + +@user_has_privilege(u'featurer') +def featured_media_panel(request): + """ + This is a new administrator panel to manage featured media. This is an + entirely optional panel, as there are other ways to manage it, but this way + gives the admin more control. + """ + form = archivalook_forms.FeaturedMediaList(request.form) + + if request.method == 'POST' and form.validate(): + featured_media = split_featured_media_list(form.box_content.data) + previous_features = FeaturedMedia.query.all() + for index, (media_entry, display_type) in enumerate(featured_media): + target = FeaturedMedia.query.filter( + FeaturedMedia.media_entry == media_entry).first() + # If this media was already featured, we don't have to create a new + # feature, we just have to edit the old one's values + if target is not None: + target.order = index + target.display_type = display_type + previous_features.remove(target) + Session.add(target) + else: + new_feature = FeaturedMedia( + media_entry=media_entry, + display_type=display_type, + order=index) + Session.add(new_feature) + [Session.delete(feature) for feature in previous_features] + + Session.commit() + + form.box_content.data = create_featured_media_textbox() + return render_to_response( + request, 'archivalook/feature.html', + {'form' : form}) + +@uses_pagination +@user_not_banned +def recent_media_gallery_view(request, page): + """ + The replaced homepage is available through this view. + """ + cursor = MediaEntry.query.filter_by(state=u'processed').\ + order_by(MediaEntry.created.desc()) + + pagination = Pagination(page, cursor) + media_entries = pagination() + return render_to_response( + request, 'archivalook/recent_media.html', + {'media_entries': media_entries, + 'pagination': pagination}) + +def add_featured_media_to_media_home(context): + """ + A context hook which allows the media home page to know whether the media + has been featured or not. + """ + context['featured_media'] = FeaturedMedia.query + return context + +@user_has_privilege(u'featurer') +@get_user_media_entry +def feature_media(request, media, **kwargs): + """ + A view to feature a new piece of media + """ + already_featured_media_ids = [f.media_entry.id + for f in FeaturedMedia.query.all()] + if not media.id in already_featured_media_ids: + new_feature = automatically_add_new_feature(media) + return redirect( + request, 'index') + +@user_has_privilege(u'featurer') +@get_user_media_entry +def unfeature_media(request, media, **kwargs): + """ + A view to unfeature a piece of media which has previously been featured. + """ + already_featured_media_ids = [f.media_entry.id + for f in FeaturedMedia.query.all()] + if media.id in already_featured_media_ids: + automatically_remove_feature(media) + return redirect( + request, 'index') + +@user_has_privilege(u'featurer') +@get_user_media_entry +def promote_featured_media(request, media, **kwargs): + """ + A view to move a piece of media up the featured stack + """ + featured_media = FeaturedMedia.query.filter( + FeaturedMedia.media_entry_id == media.id).first() + if featured_media is not None: + promote_feature(media) + return redirect( + request, 'index') + +@user_has_privilege(u'featurer') +@get_user_media_entry +def demote_featured_media(request, media, **kwargs): + """ + A view to move a piece of media down the featured stack + """ + featured_media = FeaturedMedia.query.filter( + FeaturedMedia.media_entry_id == media.id).first() + if featured_media is not None: + demote_feature(media) + return redirect( + request, 'index') + +def get_root_view(): + return root_view diff --git a/mediagoblin/plugins/metadata_display/__init__.py b/mediagoblin/plugins/metadata_display/__init__.py new file mode 100644 index 00000000..4a4c898f --- /dev/null +++ b/mediagoblin/plugins/metadata_display/__init__.py @@ -0,0 +1,41 @@ +# 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 +from pkg_resources import resource_filename + +from mediagoblin.plugins.metadata_display.lib import add_rdfa_to_readable_to_media_home +from mediagoblin.tools import pluginapi +from mediagoblin.tools.staticdirect import PluginStatic + +PLUGIN_DIR = os.path.dirname(__file__) + +def setup_plugin(): + # Register the template path. + pluginapi.register_template_path(os.path.join(PLUGIN_DIR, 'templates')) + + pluginapi.register_template_hooks( + {"media_sideinfo": "mediagoblin/plugins/metadata_display/metadata_table.html", + "head": "mediagoblin/plugins/metadata_display/bits/metadata_extra_head.html"}) + + +hooks = { + 'setup': setup_plugin, + 'static_setup': lambda: PluginStatic( + 'metadata_display', + resource_filename('mediagoblin.plugins.metadata_display', 'static') + ), + 'media_home_context':add_rdfa_to_readable_to_media_home + } diff --git a/mediagoblin/plugins/metadata_display/lib.py b/mediagoblin/plugins/metadata_display/lib.py new file mode 100644 index 00000000..0985208c --- /dev/null +++ b/mediagoblin/plugins/metadata_display/lib.py @@ -0,0 +1,31 @@ +# 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/>. + +def rdfa_to_readable(rdfa_predicate): + """ + A simple script to convert rdfa resource descriptors into a form more + accessible for humans. + """ + readable = rdfa_predicate.split(u":")[1].capitalize() + return readable + +def add_rdfa_to_readable_to_media_home(context): + """ + A context hook which adds the 'rdfa_to_readable' filter to + the media home page. + """ + context['rdfa_to_readable'] = rdfa_to_readable + return context diff --git a/mediagoblin/plugins/metadata_display/static/css/metadata_display.css b/mediagoblin/plugins/metadata_display/static/css/metadata_display.css new file mode 100644 index 00000000..e4612b02 --- /dev/null +++ b/mediagoblin/plugins/metadata_display/static/css/metadata_display.css @@ -0,0 +1,14 @@ +table.metadata_info { + font-size:85%; + margin-left:10px; +} + +table.metadata_info th { + font-weight: bold; + border-spacing: 10px; + text-align: left; +} +table.metadata_info td { + padding: 4px 8px; +} + diff --git a/mediagoblin/plugins/metadata_display/templates/mediagoblin/plugins/metadata_display/bits/metadata_extra_head.html b/mediagoblin/plugins/metadata_display/templates/mediagoblin/plugins/metadata_display/bits/metadata_extra_head.html new file mode 100644 index 00000000..4a380299 --- /dev/null +++ b/mediagoblin/plugins/metadata_display/templates/mediagoblin/plugins/metadata_display/bits/metadata_extra_head.html @@ -0,0 +1,3 @@ + <link rel="stylesheet" type="text/css" + href="{{ request.staticdirect('css/metadata_display.css', + 'metadata_display') }}"/> diff --git a/mediagoblin/plugins/metadata_display/templates/mediagoblin/plugins/metadata_display/metadata_table.html b/mediagoblin/plugins/metadata_display/templates/mediagoblin/plugins/metadata_display/metadata_table.html new file mode 100644 index 00000000..3a9d872c --- /dev/null +++ b/mediagoblin/plugins/metadata_display/templates/mediagoblin/plugins/metadata_display/metadata_table.html @@ -0,0 +1,42 @@ +{# +# 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/>. +#} +{% block metadata_information_table %} +{%- set metadata=media.media_metadata %} +{%- set metadata_context=metadata['@context'] %} +{%- if metadata %} + <h3>{% trans %}Metadata{% endtrans %}</h3> + {#- NOTE: In some smart future where the context is more extensible, + we will need to add to the prefix here-#} + <table class="metadata_info"> + {%- for key, value in metadata.iteritems() if not key=='@context' %} + {% if value -%} + <tr> + <th>{{ rdfa_to_readable(key) }}</th> + <td property="{{ key }}">{{ value }}</td> + </tr> + {%- endif -%} + {%- endfor %} + </table> +{% endif %} +{% if request.user and request.user.has_privilege('admin') %} + <a href="{{ request.urlgen('mediagoblin.edit.metadata', + user=media.get_uploader.username, + media_id=media.id) }}"> + {% trans %}Edit Metadata{% endtrans %}</a> +{% endif %} +{% endblock %} diff --git a/mediagoblin/plugins/metadata_display/templates/mediagoblin/plugins/metadata_display/metadata_table.html.orig b/mediagoblin/plugins/metadata_display/templates/mediagoblin/plugins/metadata_display/metadata_table.html.orig new file mode 100644 index 00000000..2bd1a14c --- /dev/null +++ b/mediagoblin/plugins/metadata_display/templates/mediagoblin/plugins/metadata_display/metadata_table.html.orig @@ -0,0 +1,60 @@ +{# +# 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/>. +#} + +<<<<<<< HEAD:mediagoblin/templates/mediagoblin/utils/metadata_table.html +{%- macro render_table(request, media_entry, format_predicate) %} + {%- set metadata=media_entry.media_metadata %} + {%- set metadata_context=metadata['@context'] %} + {%- if metadata %} + <h3>{% trans %}Metadata Information{% endtrans %}</h3> + <table class="metadata_info"> + {%- for key, value in metadata.iteritems() if ( + not key=='@context' and value) %} + <tr {% if loop.index%2 == 1 %}class="highlight"{% endif %}> + <th>{{ format_predicate(key) }}</th> + <td property="{{ key }}"> + {{ value }}</td> + </tr> + {%- endfor %} + </table> + {% endif %} + {% if request.user and request.user.has_privilege('admin') %} + <a href="{{ request.urlgen('mediagoblin.edit.metadata', + user=media_entry.get_uploader.username, + media_id=media_entry.id) }}"> + {% trans %}Edit Metadata{% endtrans %}</a> + {% endif %} +{%- endmacro %} +======= +{%- set metadata=media.media_metadata %} +{%- set metadata_context=metadata['@context'] %} +{%- if metadata %} + {#- NOTE: In some smart future where the context is more extensible, + we will need to add to the prefix here-#} + <table> + {%- for key, value in metadata.iteritems() if not key=='@context' %} + {% if value -%} + <tr> + <td>{{ rdfa_to_readable(key) }}</td> + <td property="{{ key }}">{{ value }}</td> + </tr> + {%- endif -%} + {%- endfor %} + </table> +{% endif %} +>>>>>>> acfcaf6366bd4695c1c37c7aa8ff5a176b412e2a:mediagoblin/plugins/metadata_display/templates/mediagoblin/plugins/metadata_display/metadata_table.html diff --git a/mediagoblin/routing.py b/mediagoblin/routing.py index 1393f01c..9f2584d3 100644 --- a/mediagoblin/routing.py +++ b/mediagoblin/routing.py @@ -28,7 +28,7 @@ _log = logging.getLogger(__name__) def get_url_map(): add_route('index', '/', 'mediagoblin.views:root_view') add_route('terms_of_service','/terms_of_service', - 'mediagoblin.views:terms_of_service') + 'mediagoblin.views:terms_of_service'), mount('/auth', auth_routes) mount('/mod', moderation_routes) diff --git a/mediagoblin/static/css/base.css b/mediagoblin/static/css/base.css index 32c6c6cb..9087034b 100644 --- a/mediagoblin/static/css/base.css +++ b/mediagoblin/static/css/base.css @@ -609,7 +609,6 @@ a img.media_image { cursor: -moz-zoom-in; cursor: zoom-in; } - /* icons */ img.media_icon { @@ -938,3 +937,16 @@ p.verifier { none repeat scroll 0% 0% rgb(221, 221, 221); padding: 1em 0px; } + +/* for the media metadata editing table */ +table.metadata_editor { + margin: 10px auto; + width: 800px; +} + +table.metadata_editor tr td { + width:350px; +} +table.metadata_editor tr td.form_field_input input { + width:350px; +} diff --git a/mediagoblin/static/metadata/rdfa11.jsonld b/mediagoblin/static/metadata/rdfa11.jsonld new file mode 100644 index 00000000..b2557233 --- /dev/null +++ b/mediagoblin/static/metadata/rdfa11.jsonld @@ -0,0 +1,48 @@ +{ + "@context": { + "cat": "http://www.w3.org/ns/dcat#", + "qb": "http://purl.org/linked-data/cube#", + "grddl": "http://www.w3.org/2003/g/data-view#", + "ma": "http://www.w3.org/ns/ma-ont#", + "owl": "http://www.w3.org/2002/07/owl#", + "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", + "rdfa": "http://www.w3.org/ns/rdfa#", + "rdfs": "http://www.w3.org/2000/01/rdf-schema#", + "rif": "http://www.w3.org/2007/rif#", + "rr": "http://www.w3.org/ns/r2rml#", + "skos": "http://www.w3.org/2004/02/skos/core#", + "skosxl": "http://www.w3.org/2008/05/skos-xl#", + "wdr": "http://www.w3.org/2007/05/powder#", + "void": "http://rdfs.org/ns/void#", + "wdrs": "http://www.w3.org/2007/05/powder-s#", + "xhv": "http://www.w3.org/1999/xhtml/vocab#", + "xml": "http://www.w3.org/XML/1998/namespace", + "xsd": "http://www.w3.org/2001/XMLSchema#", + "prov": "http://www.w3.org/ns/prov#", + "sd": "http://www.w3.org/ns/sparql-service-description#", + "org": "http://www.w3.org/ns/org#", + "gldp": "http://www.w3.org/ns/people#", + "cnt": "http://www.w3.org/2008/content#", + "dcat": "http://www.w3.org/ns/dcat#", + "earl": "http://www.w3.org/ns/earl#", + "ht": "http://www.w3.org/2006/http#", + "ptr": "http://www.w3.org/2009/pointers#", + "cc": "http://creativecommons.org/ns#", + "ctag": "http://commontag.org/ns#", + "dc": "http://purl.org/dc/terms/", + "dc11": "http://purl.org/dc/elements/1.1/", + "dcterms": "http://purl.org/dc/terms/", + "foaf": "http://xmlns.com/foaf/0.1/", + "gr": "http://purl.org/goodrelations/v1#", + "ical": "http://www.w3.org/2002/12/cal/icaltzd#", + "og": "http://ogp.me/ns#", + "rev": "http://purl.org/stuff/rev#", + "sioc": "http://rdfs.org/sioc/ns#", + "v": "http://rdf.data-vocabulary.org/#", + "vcard": "http://www.w3.org/2006/vcard/ns#", + "schema": "http://schema.org/", + "describedby": "http://www.w3.org/2007/05/powder-s#describedby", + "license": "http://www.w3.org/1999/xhtml/vocab#license", + "role": "http://www.w3.org/1999/xhtml/vocab#role" + } +}
\ No newline at end of file diff --git a/mediagoblin/submit/lib.py b/mediagoblin/submit/lib.py index c70e2731..93ae7a1f 100644 --- a/mediagoblin/submit/lib.py +++ b/mediagoblin/submit/lib.py @@ -98,7 +98,7 @@ class UserPastUploadLimit(UploadLimitError): def submit_media(mg_app, user, submitted_file, filename, title=None, description=None, - license=None, tags_string=u"", + license=None, metadata=None, tags_string=u"", upload_limit=None, max_file_size=None, callback_url=None, # If provided we'll do the feed_url update, otherwise ignore @@ -142,6 +142,8 @@ def submit_media(mg_app, user, submitted_file, filename, entry.license = license or None + entry.media_metadata = metadata or {} + # Process the user's folksonomy "tags" entry.tags = convert_to_tag_list_of_dicts(tags_string) diff --git a/mediagoblin/templates/mediagoblin/base.html b/mediagoblin/templates/mediagoblin/base.html index b4c7eb8b..ffc471d2 100644 --- a/mediagoblin/templates/mediagoblin/base.html +++ b/mediagoblin/templates/mediagoblin/base.html @@ -151,6 +151,7 @@ <a class="button_action" href="{{ request.urlgen('mediagoblin.submit.collection') }}"> {%- trans %}Create new collection{% endtrans -%} </a> + {% template_hook("header_dropdown_buttons") %} {% if request.user.has_privilege('admin','moderator') %} <p> <span class="dropdown_title">Moderation powers:</span> @@ -165,6 +166,7 @@ <a href="{{ request.urlgen('mediagoblin.moderation.reports') }}"> {%- trans %}Report management panel{% endtrans -%} </a> + {% template_hook("moderation_powers") %} </p> {% endif %} {% include 'mediagoblin/fragments/header_notifications.html' %} diff --git a/mediagoblin/templates/mediagoblin/edit/metadata.html b/mediagoblin/templates/mediagoblin/edit/metadata.html new file mode 100644 index 00000000..d0efbbfb --- /dev/null +++ b/mediagoblin/templates/mediagoblin/edit/metadata.html @@ -0,0 +1,94 @@ +{# +# 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/>. +#} +{%- extends "mediagoblin/base.html" %} +{% import "/mediagoblin/utils/wtforms.html" as wtforms_util %} +{% block mediagoblin_head %} + <script> + function add_new_row(table_id, row_number, input_prefix) { + new_row = $('<tr>').append( + $('<td>').attr( + 'class','form_field_input').append( + $('<input>').attr('name', + input_prefix + row_number + "-identifier").attr('id', + input_prefix + row_number + "-identifier") + ) + ).append( + $('<td>').attr( + 'class','form_field_input').append( + $('<input>').attr('name', + input_prefix + row_number + "-value").attr('id', + input_prefix + row_number + "-value") + ) + ); + $(table_id).append(new_row); + } + function clear_empty_rows(list_id) { + $('table'+list_id+' tr').each(function(row){ + id_input = $(this).find('td').find('input'); + value_input = $(this).find('td').next().find('input'); + if ((value_input.attr('value') == "") && + (id_input.attr('value') == "")) { + $(this).remove(); + } + }) + } + + $(document).ready(function(){ + var metadata_lines = {{ form.media_metadata | length }}; + $("#add_new_metadata_row").click(function(){ + add_new_row("#metadata_list", + metadata_lines, + 'media_metadata-'); + metadata_lines += 1; + }) + + $("#clear_empty_rows").click(function(){ + clear_empty_rows("#metadata_list"); + }) + }) + </script> +{% endblock %} +{% block mediagoblin_content %} + <h2>{% trans media_name=media.title -%} + Metadata for "{{ media_name }}"{% endtrans %}</h2> + <form action="" method="POST" id="metadata_form"> + +<!-- This table holds all the information about the media entry's metadata --> + <h3>{% trans %}MetaData{% endtrans %}</h3> + <table class="metadata_editor" id="metadata_list" > + {{ wtforms_util.render_fieldlist_as_table_rows(form.media_metadata) }} + </table> + +<!-- These are the buttons you use to control the form --> + <table class="metadata_editor" id="buttons_bottom"> + <tr> + <td><input type=button value="{% trans %}Add new Row{% endtrans %}" + class="button_action" id="add_new_metadata_row" /> + </td> + <td><input type=submit value="{% trans %}Update Metadata{% endtrans %}" + class="button_action_highlight" /></td> + </tr> + <tr> + <td><input type=button value="{% trans %}Clear empty Rows{% endtrans %}" + class="button_action" id="clear_empty_rows" /></td> + </tr> + </table> + {{ csrf_token }} + </form> + +{% endblock mediagoblin_content %} diff --git a/mediagoblin/templates/mediagoblin/user_pages/media.html b/mediagoblin/templates/mediagoblin/user_pages/media.html index e01cce5c..949cbcde 100644 --- a/mediagoblin/templates/mediagoblin/user_pages/media.html +++ b/mediagoblin/templates/mediagoblin/user_pages/media.html @@ -230,9 +230,6 @@ {% template_hook("media_sideinfo") %} - {% block mediagoblin_sidebar %} - {% endblock %} - </div><!--end media_sidebar--> <div class="clear"></div> diff --git a/mediagoblin/templates/mediagoblin/utils/wtforms.html b/mediagoblin/templates/mediagoblin/utils/wtforms.html index e079274e..7e16708c 100644 --- a/mediagoblin/templates/mediagoblin/utils/wtforms.html +++ b/mediagoblin/templates/mediagoblin/utils/wtforms.html @@ -70,23 +70,56 @@ {# Auto-render a form as a table #} {% macro render_table(form) -%} {% for field in form %} - <tr> - <th>{{ field.label.text }}</th> - <td> - {{field}} - {% if field.errors %} - <br /> - <ul class="errors"> - {% for error in field.errors %} - <li>{{error}}</li> - {% endfor %} - </ul> - {% endif %} - </td> - </tr> + render_field_as_table_row(field) {% endfor %} {%- endmacro %} +{% macro render_form_as_table_row(form) %} + <tr> + {%- for field in form %} + <td class="form_field_input"> + {{field}} + </td> + {%- endfor %} + </tr> + <tr> + {%- for field in form %} + {% for error in field.errors %} + <tr> + <td> + <p class="form_field_error">{{error}}</p> + </td> + </tr> + {%- endfor %} + {%- endfor %} +{%- endmacro %} + +{% macro render_field_as_table_row(field) %} + <tr> + <th>{{ field.label.text }}</th> + <td> + {{field}} + </td> + </tr> + {% for error in field.errors %} + <tr> + <td> + <p class="form_field_error">{{error}}</p> + </td> + </tr> + {%- endfor %} +{% endmacro %} + +{% macro render_fieldlist_as_table_rows(fieldlist) %} + {% for field in fieldlist -%} + {%- if field.type == 'FormField' %} + {{ render_form_as_table_row(field) }} + {%- else %} + {{ render_field_as_table_row(field) }} + {%- endif %} + {% endfor -%} +{% endmacro %} + {# Render a boolean field #} {% macro render_bool(field) %} <div class="boolean"> diff --git a/mediagoblin/tests/test_edit.py b/mediagoblin/tests/test_edit.py index 4f44e0b9..dc9c422f 100644 --- a/mediagoblin/tests/test_edit.py +++ b/mediagoblin/tests/test_edit.py @@ -14,11 +14,11 @@ # 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 urlparse +import urlparse, os, pytest from mediagoblin import mg_globals -from mediagoblin.db.models import User -from mediagoblin.tests.tools import fixture_add_user +from mediagoblin.db.models import User, MediaEntry +from mediagoblin.tests.tools import fixture_add_user, fixture_media_entry from mediagoblin import auth from mediagoblin.tools import template, mail @@ -174,3 +174,81 @@ class TestUserEdit(object): email = User.query.filter_by(username='chris').first().email assert email == 'new@example.com' # test changing the url inproperly + +class TestMetaDataEdit: + @pytest.fixture(autouse=True) + def setup(self, test_app): + # set up new user + self.user_password = u'toast' + self.user = fixture_add_user(password = self.user_password, + privileges=[u'active',u'admin']) + self.test_app = test_app + + def login(self, test_app): + test_app.post( + '/auth/login/', { + 'username': self.user.username, + 'password': self.user_password}) + + def do_post(self, data, *context_keys, **kwargs): + url = kwargs.pop('url', '/submit/') + do_follow = kwargs.pop('do_follow', False) + template.clear_test_template_context() + response = self.test_app.post(url, data, **kwargs) + if do_follow: + response.follow() + context_data = template.TEMPLATE_TEST_CONTEXT + for key in context_keys: + context_data = context_data[key] + return response, context_data + + def test_edit_metadata(self, test_app): + media_entry = fixture_media_entry(uploader=self.user.id, + state=u'processed') + media_slug = "/u/{username}/m/{media_id}/metadata/".format( + username = str(self.user.username), + media_id = str(media_entry.id)) + + self.login(test_app) + response = test_app.get(media_slug) + assert response.status == '200 OK' + assert media_entry.media_metadata == {} + # First test adding in metadata + ################################ + response, context = self.do_post({ + "media_metadata-0-identifier":"dc:title", + "media_metadata-0-value":"Some title", + "media_metadata-1-identifier":"dc:creator", + "media_metadata-1-value":"Me"},url=media_slug) + + media_entry = MediaEntry.query.first() + new_metadata = media_entry.media_metadata + assert new_metadata != {} + assert new_metadata.get("dc:title") == "Some title" + assert new_metadata.get("dc:creator") == "Me" + # Now test removing the metadata + ################################ + response, context = self.do_post({ + "media_metadata-0-identifier":"dc:title", + "media_metadata-0-value":"Some title"},url=media_slug) + + media_entry = MediaEntry.query.first() + new_metadata = media_entry.media_metadata + assert new_metadata.get("dc:title") == "Some title" + assert new_metadata.get("dc:creator") is None + # Now test adding bad metadata + ############################### + response, context = self.do_post({ + "media_metadata-0-identifier":"dc:title", + "media_metadata-0-value":"Some title", + "media_metadata-1-identifier":"dc:creator", + "media_metadata-1-value":"Me", + "media_metadata-2-identifier":"dc:created", + "media_metadata-2-value":"On the worst day"},url=media_slug) + + media_entry = MediaEntry.query.first() + old_metadata = new_metadata + new_metadata = media_entry.media_metadata + assert new_metadata == old_metadata + assert ("u'On the worst day' is not a 'date-time'" in + response.body) diff --git a/mediagoblin/tests/test_metadata.py b/mediagoblin/tests/test_metadata.py new file mode 100644 index 00000000..b4ea646e --- /dev/null +++ b/mediagoblin/tests/test_metadata.py @@ -0,0 +1,78 @@ +# 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 pytest +from mediagoblin.tools.metadata import compact_and_validate +from jsonschema import ValidationError + +class TestMetadataFunctionality: + + @pytest.fixture(autouse=True) + def _setup(self, test_app): + self.test_app = test_app + + def testCompactAndValidate(self): + # First, test out a well formatted piece of metadata + ###################################################### + test_metadata = { + 'dc:title':'My Pet Bunny', + 'dc:description':'A picture displaying how cute my pet bunny is.', + 'location':'/home/goblin/Pictures/bunny.png', + 'license':'http://www.gnu.org/licenses/gpl.txt' + } + jsonld_metadata =compact_and_validate(test_metadata) + assert jsonld_metadata + assert jsonld_metadata.get('dc:title') == 'My Pet Bunny' + # Free floating nodes should be removed + assert jsonld_metadata.get('location') is None + assert jsonld_metadata.get('@context') == \ + u"http://www.w3.org/2013/json-ld-context/rdfa11" + + # Next, make sure that various badly formatted metadata + # will be rejected. + ####################################################### + #,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,. + # Metadata with a non-URI license should fail : + #`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`' + metadata_fail_1 = { + 'dc:title':'My Pet Bunny', + 'dc:description':'A picture displaying how cute my pet bunny is.', + 'location':'/home/goblin/Pictures/bunny.png', + 'license':'All Rights Reserved.' + } + jsonld_fail_1 = None + try: + jsonld_fail_1 = compact_and_validate(metadata_fail_1) + except ValidationError, e: + assert e.message == "'All Rights Reserved.' is not a 'uri'" + assert jsonld_fail_1 == None + #,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,.,., + # Metadata with an ivalid date-time dc:created should fail : + #`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'`'' + metadata_fail_2 = { + 'dc:title':'My Pet Bunny', + 'dc:description':'A picture displaying how cute my pet bunny is.', + 'location':'/home/goblin/Pictures/bunny.png', + 'license':'http://www.gnu.org/licenses/gpl.txt', + 'dc:created':'The other day' + } + jsonld_fail_2 = None + try: + jsonld_fail_2 = compact_and_validate(metadata_fail_2) + except ValidationError, e: + assert e.message == "'The other day' is not a 'date-time'" + assert jsonld_fail_2 == None + diff --git a/mediagoblin/tools/metadata.py b/mediagoblin/tools/metadata.py new file mode 100644 index 00000000..bfefcac9 --- /dev/null +++ b/mediagoblin/tools/metadata.py @@ -0,0 +1,222 @@ +# 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 copy +import json +import re +from pkg_resources import resource_filename + +import dateutil.parser +from pyld import jsonld +from jsonschema import validate, FormatChecker, draft4_format_checker +from jsonschema.compat import str_types + +from mediagoblin.tools.pluginapi import hook_handle + + + +######################################################## +## Set up the MediaGoblin format checker for json-schema +######################################################## + +URL_REGEX = re.compile( + r'^[a-z]+://([^/:]+|([0-9]{1,3}\.){3}[0-9]{1,3})(:[0-9]+)?(\/.*)?$', + re.IGNORECASE) + +def is_uri(instance): + """ + jsonschema uri validator + """ + if not isinstance(instance, str_types): + return True + + return URL_REGEX.match(instance) + +def is_datetime(instance): + """ + Is a date or datetime readable string. + """ + if not isinstance(instance, str_types): + return True + + return dateutil.parser.parse(instance) + + +class DefaultChecker(FormatChecker): + """ + Default MediaGoblin format checker... extended to include a few extra things + """ + checkers = copy.deepcopy(draft4_format_checker.checkers) + + +DefaultChecker.checkers[u"uri"] = (is_uri, ()) +DefaultChecker.checkers[u"date-time"] = (is_datetime, (ValueError, TypeError)) +DEFAULT_CHECKER = DefaultChecker() + +# Crappy default schema, checks for things we deem important + +DEFAULT_SCHEMA = { + "$schema": "http://json-schema.org/schema#", + + "type": "object", + "properties": { + "license": { + "format": "uri", + "type": "string", + }, + "dcterms:created": { + "format": "date-time", + "type": "string", + }, + "dc:created": { + "format": "date-time", + "type": "string", + } + }, +} + + +def load_resource(package, resource_path): + """ + Load a resource, return it as a string. + + Args: + - package: package or module name. Eg "mediagoblin.media_types.audio" + - resource_path: path to get to this resource, a list of + directories and finally a filename. Will be joined with + os.path.sep. + """ + filename = resource_filename(package, os.path.sep.join(resource_path)) + return file(filename).read() + +def load_resource_json(package, resource_path): + """ + Load a resource json file, return a dictionary. + + Args: + - package: package or module name. Eg "mediagoblin.media_types.audio" + - resource_path: path to get to this resource, a list of + directories and finally a filename. Will be joined with + os.path.sep. + """ + return json.loads(load_resource(package, resource_path)) + + +################################## +## Load the MediaGoblin core files +################################## + + +BUILTIN_CONTEXTS = { + "http://www.w3.org/2013/json-ld-context/rdfa11": load_resource( + "mediagoblin", ["static", "metadata", "rdfa11.jsonld"])} + + +_CONTEXT_CACHE = {} + +def load_context(url): + """ + A self-aware document loader. For those contexts MediaGoblin + stores internally, load them from disk. + """ + if url in _CONTEXT_CACHE: + return _CONTEXT_CACHE[url] + + # See if it's one of our basic ones + document = BUILTIN_CONTEXTS.get(url, None) + + # No? See if we have an internal schema for this + if document is None: + document = hook_handle(("context_url_data", url)) + + # Okay, if we've gotten a document by now... let's package it up + if document is not None: + document = {'contextUrl': None, + 'documentUrl': url, + 'document': document} + + # Otherwise, use jsonld.load_document + else: + document = jsonld.load_document(url) + + # cache + _CONTEXT_CACHE[url] = document + return document + + +DEFAULT_CONTEXT = "http://www.w3.org/2013/json-ld-context/rdfa11" + +def compact_json(metadata, context=DEFAULT_CONTEXT): + """ + Compact json with supplied context. + + Note: Free floating" nodes are removed (eg a key just named + "bazzzzzz" which isn't specified in the context... something like + bazzzzzz:blerp will stay though. This is jsonld.compact behavior. + """ + compacted = jsonld.compact( + metadata, context, + options={ + "documentLoader": load_context, + # This allows for things like "license" and etc to be preserved + "expandContext": context, + "keepFreeFloatingNodes": False}) + + return compacted + + +def compact_and_validate(metadata, context=DEFAULT_CONTEXT, + schema=DEFAULT_SCHEMA): + """ + compact json with supplied context, check against schema for errors + + raises an exception (jsonschema.exceptions.ValidationError) if + there's an error. + + Note: Free floating" nodes are removed (eg a key just named + "bazzzzzz" which isn't specified in the context... something like + bazzzzzz:blerp will stay though. This is jsonld.compact behavior. + + You may wish to do this validation yourself... this is just for convenience. + """ + compacted = compact_json(metadata, context) + validate(metadata, schema, format_checker=DEFAULT_CHECKER) + + return compacted + + +def expand_json(metadata, context=DEFAULT_CONTEXT): + """ + Expand json, but be sure to use our documentLoader. + + By default this expands with DEFAULT_CONTEXT, but if you do not need this, + you can safely set this to None. + + # @@: Is the above a good idea? Maybe it should be set to None by + # default. + """ + options = { + "documentLoader": load_context} + if context is not None: + options["expandContext"] = context + return jsonld.expand(metadata, options=options) + + +def rdfa_to_readable(rdfa_predicate): + readable = rdfa_predicate.split(u":")[1].capitalize() + return readable diff --git a/mediagoblin/tools/translate.py b/mediagoblin/tools/translate.py index 257bd791..f77351b5 100644 --- a/mediagoblin/tools/translate.py +++ b/mediagoblin/tools/translate.py @@ -32,7 +32,7 @@ TRANSLATIONS_PATH = pkg_resources.resource_filename( 'mediagoblin', 'i18n') # Known RTL languages -KNOWN_RTL = set(["ar", "fa", "zh","he","iw","ja","ur","yi","ji"]) +KNOWN_RTL = set(["ar", "fa", "he", "iw", "ur", "yi", "ji"]) def is_rtl(lang): """Returns true when the local language is right to left""" diff --git a/mediagoblin/user_pages/routing.py b/mediagoblin/user_pages/routing.py index f0f4d8b7..8eb51c8d 100644 --- a/mediagoblin/user_pages/routing.py +++ b/mediagoblin/user_pages/routing.py @@ -101,3 +101,7 @@ add_route('mediagoblin.edit.edit_media', add_route('mediagoblin.edit.attachments', '/u/<string:user>/m/<int:media_id>/attachments/', 'mediagoblin.edit.views:edit_attachments') + +add_route('mediagoblin.edit.metadata', + '/u/<string:user>/m/<int:media_id>/metadata/', + 'mediagoblin.edit.views:edit_metadata') @@ -66,8 +66,12 @@ try: 'mock', 'itsdangerous', 'pytz', + 'six>=1.4.1', 'oauthlib==0.5.0', 'unidecode', + 'jsonschema', + 'requests', + 'pyld', 'ExifRead', # PLEASE change this when we can; a dependency is forcing us to set this |