From e8fda91bc2326911ea9a0197e595bc333540c282 Mon Sep 17 00:00:00 2001 From: cfdv Date: Fri, 17 Jun 2011 22:26:17 -0500 Subject: [PATCH 01/23] fixes uneven whitespace, and conforms to a strong preference for less than 80 characters per line --- mediagoblin/templates/mediagoblin/user_pages/gallery.html | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/mediagoblin/templates/mediagoblin/user_pages/gallery.html b/mediagoblin/templates/mediagoblin/user_pages/gallery.html index 1d8fbdaa..6f68a41f 100644 --- a/mediagoblin/templates/mediagoblin/user_pages/gallery.html +++ b/mediagoblin/templates/mediagoblin/user_pages/gallery.html @@ -26,9 +26,10 @@ {% block mediagoblin_content -%} {% if user %} -

gallery for {{ user.username }}

+

gallery for + {{ user.username }}

{% include "mediagoblin/utils/object_gallery.html" %} From 9f661642ef073ff4f820573d06f6ef9896ce8f3f Mon Sep 17 00:00:00 2001 From: Jef van Schendel Date: Fri, 24 Jun 2011 21:03:05 +0200 Subject: [PATCH 02/23] Implement basic footer --- mediagoblin/static/css/base.css | 27 +++++++++++++++++++++ mediagoblin/templates/mediagoblin/base.html | 13 +++++++++- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/mediagoblin/static/css/base.css b/mediagoblin/static/css/base.css index 9c9bcea3..31f14680 100644 --- a/mediagoblin/static/css/base.css +++ b/mediagoblin/static/css/base.css @@ -4,6 +4,12 @@ body { font-family: sans-serif; padding:none; margin:0px; + height:100%; +} + +form { + margin:0px; + padding:0px; } /* Carter One font */ @@ -38,6 +44,11 @@ label { /* website structure */ +.mediagoblin_body { + position:relative; + min-height:100%; +} + .mediagoblin_header { width:100%; height:36px; @@ -46,6 +57,22 @@ label { margin-bottom:40px; } +.mediagoblin_footer { + width:100%; + height:26px; + background-color:#393939; + bottom:0px; + padding-top:8px; + position:absolute; + text-align:center; + font-size:14px; + color:#999; +} + +.mediagoblin_content { + padding-bottom:74px; +} + a.mediagoblin_logo { width:34px; height:25px; diff --git a/mediagoblin/templates/mediagoblin/base.html b/mediagoblin/templates/mediagoblin/base.html index 6250bf3c..63749f68 100644 --- a/mediagoblin/templates/mediagoblin/base.html +++ b/mediagoblin/templates/mediagoblin/base.html @@ -28,6 +28,7 @@ {% block mediagoblin_body %} +
{% block mediagoblin_header %}
@@ -50,12 +51,22 @@
{% endblock %} -
+
{% block mediagoblin_content %} {% endblock mediagoblin_content %}
+ {% block mediagoblin_footer %} +
+
+
+ Powered by MediaGoblin, a GNU project +
+
+
+ {% endblock %} {% endblock mediagoblin_body %} +
From 528f9acd23d1c474a6092f67c4187d9f074de3a2 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Fri, 24 Jun 2011 23:46:11 -0500 Subject: [PATCH 03/23] Separates out the field rendering part from the whole form rendering macro Also adds a textarea-specific version that renders rows and cols as part of the input. --- .../templates/mediagoblin/utils/wtforms.html | 52 ++++++++++++++----- 1 file changed, 38 insertions(+), 14 deletions(-) diff --git a/mediagoblin/templates/mediagoblin/utils/wtforms.html b/mediagoblin/templates/mediagoblin/utils/wtforms.html index 9adf8e53..1d2f8619 100644 --- a/mediagoblin/templates/mediagoblin/utils/wtforms.html +++ b/mediagoblin/templates/mediagoblin/utils/wtforms.html @@ -16,23 +16,47 @@ # along with this program. If not, see . #} +{# Generically render a field #} +{% macro render_field_div(field) %} +
+
{{ field.label }}
+ {% if field.description -%} +
{{ field.description }}
+ {%- endif %} +
{{ field }}
+ {%- if field.errors -%} + {% for error in field.errors %} +
+ {{ error }} +
+ {% endfor %} + {%- endif %} +
+{%- endmacro %} + +{# Generically render a textarea + # ... mostly the same thing except it includes rows and cols #} +{% macro render_textarea_div(field, rows=8, cols=20) %} +
+
{{ field.label }}
+ {% if field.description -%} +
{{ field.description }}
+ {%- endif %} +
{{ field(rows=rows, cols=cols) }}
+ {%- if field.errors -%} + {% for error in field.errors %} +
+ {{ error }} +
+ {% endfor %} + {%- endif %} +
+{%- endmacro %} + {# Auto-render a form as a series of divs #} {% macro render_divs(form) -%} {% for field in form %} -
-
{{ field.label }}
- {% if field.description -%} -
{{ field.description }}
- {%- endif %} -
{{ field }}
- {%- if field.errors -%} - {% for error in field.errors %} -
- {{ error }} -
- {% endfor %} - {%- endif %} -
+ {{ render_field_div(field) }} {% endfor %} {%- endmacro %} From 353f927e9f4343e56503b3144e25095dcbbe7cfa Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Fri, 24 Jun 2011 23:49:37 -0500 Subject: [PATCH 04/23] Adjust the width of the fields on the form submission Did several things, including: - Call the individual form field rendering macros instead of the auto whole-form renderer so we get better control over the TextArea - Use the textarea specific form field rendering macro - Adds textarea styling to the css - Sets the input, textarea styling to be 460 px wide (the width of the form section, not including padding) --- mediagoblin/static/css/base.css | 4 ++-- mediagoblin/templates/mediagoblin/submit/start.html | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/mediagoblin/static/css/base.css b/mediagoblin/static/css/base.css index 31f14680..36c8fca8 100644 --- a/mediagoblin/static/css/base.css +++ b/mediagoblin/static/css/base.css @@ -146,8 +146,8 @@ a.mediagoblin_logo:hover { font-size:28px; } -.form_field_input input { - width:300px; +.form_field_input input, .form_field_input textarea { + width:460px; font-size:18px; } diff --git a/mediagoblin/templates/mediagoblin/submit/start.html b/mediagoblin/templates/mediagoblin/submit/start.html index 00577fa1..f34bf2af 100644 --- a/mediagoblin/templates/mediagoblin/submit/start.html +++ b/mediagoblin/templates/mediagoblin/submit/start.html @@ -25,7 +25,9 @@ method="POST" enctype="multipart/form-data">

Submit yer media

- {{ wtforms_util.render_divs(submit_form) }} + {{ wtforms_util.render_field_div(submit_form.title) }} + {{ wtforms_util.render_textarea_div(submit_form.description) }} + {{ wtforms_util.render_field_div(submit_form.file) }}
From 39c76f30f08e7504c03c1023589a22789b6d6f12 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Fri, 24 Jun 2011 23:53:31 -0500 Subject: [PATCH 05/23] Setting height for media thumbnail to also 200px Not sure why height wasn't at 200px but anyway not having at 200px means some images would hit overlap. --- mediagoblin/static/css/base.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mediagoblin/static/css/base.css b/mediagoblin/static/css/base.css index 36c8fca8..78604613 100644 --- a/mediagoblin/static/css/base.css +++ b/mediagoblin/static/css/base.css @@ -186,7 +186,7 @@ ul.media_thumbnail { li.media_thumbnail { width:200px; - height:133px; + height:200px; display:-moz-inline-stack; display:inline-block; vertical-align:top; From 426685e088cd1867c12fc2721d2430e1be335297 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Sat, 25 Jun 2011 00:28:03 -0500 Subject: [PATCH 06/23] Put the thumbnail on the edit details part on the top and center --- mediagoblin/templates/mediagoblin/edit/edit.html | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/mediagoblin/templates/mediagoblin/edit/edit.html b/mediagoblin/templates/mediagoblin/edit/edit.html index 12ddd535..8ee09bd5 100644 --- a/mediagoblin/templates/mediagoblin/edit/edit.html +++ b/mediagoblin/templates/mediagoblin/edit/edit.html @@ -27,13 +27,15 @@ method="POST" enctype="multipart/form-data">

Editing {{ media.title }}

+
+ +
{{ wtforms_util.render_divs(form) }}
Cancel
-
From f7b7511b7b7c4cb73c196d5a6d38314a1162dae4 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Sat, 25 Jun 2011 12:55:42 -0500 Subject: [PATCH 07/23] Make the width of these fields 100% rather than providing a specific pixel width. --- mediagoblin/static/css/base.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mediagoblin/static/css/base.css b/mediagoblin/static/css/base.css index 78604613..0a659bb4 100644 --- a/mediagoblin/static/css/base.css +++ b/mediagoblin/static/css/base.css @@ -147,7 +147,7 @@ a.mediagoblin_logo:hover { } .form_field_input input, .form_field_input textarea { - width:460px; + width:100%; font-size:18px; } From fcb3166270d47ce85725072cf304ed9fc570b96c Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Sat, 25 Jun 2011 13:10:25 -0500 Subject: [PATCH 08/23] Just adjusting indentation a little bit in the base template. --- mediagoblin/templates/mediagoblin/base.html | 46 +++++++++++---------- 1 file changed, 24 insertions(+), 22 deletions(-) diff --git a/mediagoblin/templates/mediagoblin/base.html b/mediagoblin/templates/mediagoblin/base.html index 63749f68..2b47a14c 100644 --- a/mediagoblin/templates/mediagoblin/base.html +++ b/mediagoblin/templates/mediagoblin/base.html @@ -30,41 +30,43 @@ {% block mediagoblin_body %}
{% block mediagoblin_header %} -
-
-
- {% block mediagoblin_logo %} - - {% endblock %}{% block mediagoblin_header_title %}{% endblock %} -
- {% if request.user %} - - {{ request.user['username'] }}'s account - (logout) - {% else %} - - Login - {% endif %} +
+
+
+ {% block mediagoblin_logo %} + + {% endblock %}{% block mediagoblin_header_title %}{% endblock %} +
+ {% if request.user %} + + {{ request.user['username'] }}'s account + (logout) + {% else %} + + Login + {% endif %} +
-
{% endblock %} +
{% block mediagoblin_content %} {% endblock mediagoblin_content %}
+ {% block mediagoblin_footer %} -
-
-
- Powered by MediaGoblin, a GNU project +
+
+
+ Powered by MediaGoblin, a GNU project +
-
{% endblock %} {% endblock mediagoblin_body %}
From d4a7a03ce731dcfc42fabae2802b2963591c1e70 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Sat, 25 Jun 2011 13:15:15 -0500 Subject: [PATCH 09/23] Align images in a gallery to the center --- mediagoblin/static/css/base.css | 1 + 1 file changed, 1 insertion(+) diff --git a/mediagoblin/static/css/base.css b/mediagoblin/static/css/base.css index 0a659bb4..e39770d5 100644 --- a/mediagoblin/static/css/base.css +++ b/mediagoblin/static/css/base.css @@ -191,6 +191,7 @@ li.media_thumbnail { display:inline-block; vertical-align:top; margin:0px 10px 10px 0px; + text-align:center; zoom:1; . *display:inline; } From e1d9e1d139a81d4d7592d349e3594d3a9d21c285 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Sat, 25 Jun 2011 14:32:31 -0500 Subject: [PATCH 10/23] Reordering the uploaded on/by and description sections of media display template --- .../mediagoblin/user_pages/media.html | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/mediagoblin/templates/mediagoblin/user_pages/media.html b/mediagoblin/templates/mediagoblin/user_pages/media.html index d221f61e..97ff8e51 100644 --- a/mediagoblin/templates/mediagoblin/user_pages/media.html +++ b/mediagoblin/templates/mediagoblin/user_pages/media.html @@ -25,16 +25,18 @@ +

+ Uploaded on + {{ "%4d-%02d-%02d"|format(media.created.year, + media.created.month, media.created.day) }} + by + + {{- media.uploader().username }} +

{% autoescape False %} -

{{ media.description_html }}

+

{{ media.description_html }}

{% endautoescape %} -

Uploaded on - {{ "%4d-%02d-%02d"|format(media.created.year, - media.created.month, media.created.day) }} - by - - {{- media.uploader().username }}

{% if media['uploader'] == request.user['_id'] %}

Date: Sun, 26 Jun 2011 21:10:16 -0500 Subject: [PATCH 12/23] A base set of indexes for us to use with our new indexing tool. --- mediagoblin/db/indexes.py | 103 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 mediagoblin/db/indexes.py diff --git a/mediagoblin/db/indexes.py b/mediagoblin/db/indexes.py new file mode 100644 index 00000000..4e99b8c8 --- /dev/null +++ b/mediagoblin/db/indexes.py @@ -0,0 +1,103 @@ +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011 Free Software Foundation, Inc +# +# 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 . + +""" +Indexes for the local database. + +Indexes are recorded in the following format: + +INDEXES = { + 'identifier': { # key identifier used for possibly deprecating later + 'collection': 'thiscollection', + 'index': [index_foo_goes_here]}} + +... and anything else being parameters to the create_index function +(including unique=True, etc) + +Current indexes must be registered in ACTIVE_INDEXES... deprecated +indexes should be marked in DEPRECATED_INDEXES. + +Remember, ordering of compound indexes MATTERS. Read below for more. + +REQUIRED READING: + - http://kylebanker.com/blog/2010/09/21/the-joy-of-mongodb-indexes/ + - http://www.mongodb.org/display/DOCS/Indexes + - http://www.mongodb.org/display/DOCS/Indexing+Advice+and+FAQ +""" + +from pymongo import ASCENDING, DESCENDING + + +################ +# Active indexes +################ +ACTIVE_INDEXES = {} + +# MediaEntry indexes +# ------------------ + +MEDIAENTRY_INDEXES = { + 'mediaentry_uploader_slug_unique': { + # Matching an object to an uploader + slug. + # MediaEntries are unique on these two combined, eg: + # /u/${myuser}/m/${myslugname}/ + 'collection': 'media_entries', + 'index': [('uploader', ASCENDING), + ('slug', ASCENDING)], + 'unique': True}, + + 'mediaentry_created': { + # A global index for all media entries created, in descending + # order. This is used for the site's frontpage. + 'collection': 'media_entries', + 'index': [('created', DESCENDING)]}, + + 'mediaentry_uploader_created': { + # Indexing on uploaders and when media entries are created. + # Used for showing a user gallery, etc. + 'collection': 'media_entries', + 'index': [('uploader', ASCENDING), + ('created', DESCENDING)]}} + + +ACTIVE_INDEXES.update( + [MEDIAENTRY_INDEXES]) + + +# User indexes +# ------------ + +USER_INDEXES = { + 'user_username_unique': { + # Index usernames, and make sure they're unique. + # ... I guess we might need to adjust this once we're federated :) + 'collection': 'users', + 'index': 'username'}, + 'user_created': { + # All most recently created users + 'collection': 'users', + 'index': 'created'}} + + +ACTIVE_INDEXES.update( + [USER_INDEXES]) + + +#################### +# Deprecated indexes +#################### + +DEPRECATED_INDEXES = [] From ca5d2c51b68b67232263a08736da3515ce616290 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Sun, 26 Jun 2011 21:51:38 -0500 Subject: [PATCH 13/23] Store the collection information in the ACTIVE_INDEXES keys --- mediagoblin/db/indexes.py | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/mediagoblin/db/indexes.py b/mediagoblin/db/indexes.py index 4e99b8c8..85d43471 100644 --- a/mediagoblin/db/indexes.py +++ b/mediagoblin/db/indexes.py @@ -20,9 +20,9 @@ Indexes for the local database. Indexes are recorded in the following format: INDEXES = { - 'identifier': { # key identifier used for possibly deprecating later - 'collection': 'thiscollection', - 'index': [index_foo_goes_here]}} + 'collection_name': { + 'identifier': { # key identifier used for possibly deprecating later + 'index': [index_foo_goes_here]}} ... and anything else being parameters to the create_index function (including unique=True, etc) @@ -34,6 +34,7 @@ Remember, ordering of compound indexes MATTERS. Read below for more. REQUIRED READING: - http://kylebanker.com/blog/2010/09/21/the-joy-of-mongodb-indexes/ + - http://www.mongodb.org/display/DOCS/Indexes - http://www.mongodb.org/display/DOCS/Indexing+Advice+and+FAQ """ @@ -54,7 +55,6 @@ MEDIAENTRY_INDEXES = { # Matching an object to an uploader + slug. # MediaEntries are unique on these two combined, eg: # /u/${myuser}/m/${myslugname}/ - 'collection': 'media_entries', 'index': [('uploader', ASCENDING), ('slug', ASCENDING)], 'unique': True}, @@ -62,19 +62,16 @@ MEDIAENTRY_INDEXES = { 'mediaentry_created': { # A global index for all media entries created, in descending # order. This is used for the site's frontpage. - 'collection': 'media_entries', 'index': [('created', DESCENDING)]}, 'mediaentry_uploader_created': { # Indexing on uploaders and when media entries are created. # Used for showing a user gallery, etc. - 'collection': 'media_entries', 'index': [('uploader', ASCENDING), ('created', DESCENDING)]}} -ACTIVE_INDEXES.update( - [MEDIAENTRY_INDEXES]) +ACTIVE_INDEXES['media_entries'] = MEDIAENTRY_INDEXES # User indexes @@ -84,20 +81,18 @@ USER_INDEXES = { 'user_username_unique': { # Index usernames, and make sure they're unique. # ... I guess we might need to adjust this once we're federated :) - 'collection': 'users', - 'index': 'username'}, + 'index': 'username', + 'unique': True}, 'user_created': { # All most recently created users - 'collection': 'users', 'index': 'created'}} -ACTIVE_INDEXES.update( - [USER_INDEXES]) +ACTIVE_INDEXES['users'] = USER_INDEXES #################### # Deprecated indexes #################### -DEPRECATED_INDEXES = [] +DEPRECATED_INDEXES = {} From 2264670357754ae546ed69e3c825da8860b372aa Mon Sep 17 00:00:00 2001 From: Caleb Forbes Davis V Date: Mon, 27 Jun 2011 13:13:52 -0500 Subject: [PATCH 14/23] adds message queue Feature #368 - messaging framework * message levels are debug, info, success, warning, and error * display mechanism - base.html includes messages.html for now * fetch_messages and add_message are available to all templates using jinja2 environment.globals * messages are displayed and cleared. no persistence --- mediagoblin/messages.py | 34 +++++++++++++++++++ mediagoblin/templates/mediagoblin/base.html | 2 ++ .../templates/mediagoblin/utils/messages.html | 28 +++++++++++++++ mediagoblin/util.py | 7 ++++ 4 files changed, 71 insertions(+) create mode 100644 mediagoblin/messages.py create mode 100644 mediagoblin/templates/mediagoblin/utils/messages.html diff --git a/mediagoblin/messages.py b/mediagoblin/messages.py new file mode 100644 index 00000000..afe6ee7e --- /dev/null +++ b/mediagoblin/messages.py @@ -0,0 +1,34 @@ +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011 Free Software Foundation, Inc +# +# 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 . + +DEBUG = 'debug' +INFO = 'info' +SUCCESS = 'success' +WARNING = 'warning' +ERROR = 'error' + +def add_message(request, level, text): + messages = request.session.setdefault('messages', []) + messages.append({'level': level, 'text': text}) + request.session.save() + +def fetch_messages(request, clear_from_session=True): + messages = request.session.get('messages') + if messages and clear_from_session: + # Save that we removed the messages from the session + request.session['messages'] = [] + request.session.save() + return messages diff --git a/mediagoblin/templates/mediagoblin/base.html b/mediagoblin/templates/mediagoblin/base.html index 2b47a14c..58de7325 100644 --- a/mediagoblin/templates/mediagoblin/base.html +++ b/mediagoblin/templates/mediagoblin/base.html @@ -51,6 +51,8 @@

{% endblock %} + + {% include "mediagoblin/utils/messages.html" %}
diff --git a/mediagoblin/templates/mediagoblin/utils/messages.html b/mediagoblin/templates/mediagoblin/utils/messages.html new file mode 100644 index 00000000..a8d9c37e --- /dev/null +++ b/mediagoblin/templates/mediagoblin/utils/messages.html @@ -0,0 +1,28 @@ +{# +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011 Free Software Foundation, Inc +# +# 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 . +#} + +{# Display any queued messages #} +{% set messages = fetch_messages(request) %} +{% if messages %} +
    + {% for msg in messages %} +
  • {{ msg.text }}
    • + {% endfor %} +
+{% endif %} + diff --git a/mediagoblin/util.py b/mediagoblin/util.py index 91fbee0a..f0229300 100644 --- a/mediagoblin/util.py +++ b/mediagoblin/util.py @@ -32,6 +32,7 @@ from lxml.html.clean import Cleaner import markdown from mediagoblin import mg_globals +from mediagoblin import messages from mediagoblin.db.util import ObjectId TESTS_ENABLED = False @@ -104,6 +105,12 @@ def get_jinja_env(template_loader, locale): mg_globals.translations.gettext, mg_globals.translations.ngettext) + # All templates will know how to ... + # ... add a new message to the message queue + template_env.globals['add_message'] = messages.add_message + # ... fetch all waiting messages and remove them from the queue + template_env.globals['fetch_messages'] = messages.fetch_messages + if exists(locale): SETUP_JINJA_ENVS[locale] = template_env From 0f3167c9f01487bfddb43f1e859209c502a3db75 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Mon, 27 Jun 2011 16:56:12 -0500 Subject: [PATCH 15/23] Tools to add / remove indexes from collections --- mediagoblin/db/util.py | 65 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/mediagoblin/db/util.py b/mediagoblin/db/util.py index 470da531..219617ec 100644 --- a/mediagoblin/db/util.py +++ b/mediagoblin/db/util.py @@ -14,8 +14,73 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . +""" +Utilities for database operations. + +Some note on migration and indexing tools: + +We store information about what the state of the database is in the +'mediagoblin' document of the 'app_metadata' collection. Keys in that +document relevant to here: + + - 'migration_number': The integer representing the current state of + the migrations +""" + +import copy # Imports that other modules might use from pymongo import DESCENDING from pymongo.errors import InvalidId from mongokit import ObjectId + +from mediagoblin.db.indexes import ACTIVE_INDEXES, DEPRECATED_INDEXES + + +def add_new_indexes(database, active_indexes=ACTIVE_INDEXES): + """ + Add any new indexes to the database. + + Returns: + A list of indexes added in form ('collection', 'index_name') + """ + indexes_added = [] + + for collection_name, indexes in active_indexes.iteritems(): + collection = database[collection_name] + collection_indexes = collection.index_information().keys() + + for index_name, index_data in indexes.iteritems(): + if not index_name in collection_indexes: + # Get a copy actually so we don't modify the actual + # structure + index_data = copy.copy(index_data) + index = index_data.pop('index') + collection.create_index( + index, name=index_name, **index_data) + + indexes_added.append((collection_name, index_name)) + + return indexes_added + + +def remove_deprecated_indexes(database, deprecated_indexes=DEPRECATED_INDEXES): + """ + Remove any deprecated indexes from the database. + + Returns: + A list of indexes removed in form ('collection', 'index_name') + """ + indexes_removed = [] + + for collection_name, indexes in deprecated_indexes.iteritems(): + collection = database[collection_name] + collection_indexes = collection.index_information().keys() + + for index_name, index_data in indexes.iteritems(): + if index_name in collection_indexes: + collection.drop_index(index_name) + + indexes_removed.append((collection_name, index_name)) + + return indexes_removed From b1db6f20dd3cdef9da9ad27513aeee2738c85262 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Mon, 27 Jun 2011 16:56:41 -0500 Subject: [PATCH 16/23] Adding our current indexes and removing the index that was in models.py --- mediagoblin/db/indexes.py | 18 ++++++++++++------ mediagoblin/db/models.py | 5 ----- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/mediagoblin/db/indexes.py b/mediagoblin/db/indexes.py index 85d43471..bd97f9f2 100644 --- a/mediagoblin/db/indexes.py +++ b/mediagoblin/db/indexes.py @@ -37,6 +37,8 @@ REQUIRED READING: - http://www.mongodb.org/display/DOCS/Indexes - http://www.mongodb.org/display/DOCS/Indexing+Advice+and+FAQ + + """ from pymongo import ASCENDING, DESCENDING @@ -51,7 +53,7 @@ ACTIVE_INDEXES = {} # ------------------ MEDIAENTRY_INDEXES = { - 'mediaentry_uploader_slug_unique': { + 'uploader_slug_unique': { # Matching an object to an uploader + slug. # MediaEntries are unique on these two combined, eg: # /u/${myuser}/m/${myslugname}/ @@ -59,12 +61,12 @@ MEDIAENTRY_INDEXES = { ('slug', ASCENDING)], 'unique': True}, - 'mediaentry_created': { + 'created': { # A global index for all media entries created, in descending # order. This is used for the site's frontpage. 'index': [('created', DESCENDING)]}, - 'mediaentry_uploader_created': { + 'uploader_created': { # Indexing on uploaders and when media entries are created. # Used for showing a user gallery, etc. 'index': [('uploader', ASCENDING), @@ -78,15 +80,15 @@ ACTIVE_INDEXES['media_entries'] = MEDIAENTRY_INDEXES # ------------ USER_INDEXES = { - 'user_username_unique': { + 'username_unique': { # Index usernames, and make sure they're unique. # ... I guess we might need to adjust this once we're federated :) 'index': 'username', 'unique': True}, - 'user_created': { + 'created': { # All most recently created users 'index': 'created'}} - + ACTIVE_INDEXES['users'] = USER_INDEXES @@ -95,4 +97,8 @@ ACTIVE_INDEXES['users'] = USER_INDEXES # Deprecated indexes #################### +# @@: Do we really need to keep the index form if we're removing by +# key name? I guess it's helpful to keep the record... + + DEPRECATED_INDEXES = {} diff --git a/mediagoblin/db/models.py b/mediagoblin/db/models.py index 600b79ff..8d06ae49 100644 --- a/mediagoblin/db/models.py +++ b/mediagoblin/db/models.py @@ -108,11 +108,6 @@ class MediaEntry(Document): migration_handler = migrations.MediaEntryMigration - indexes = [ - # Referene uniqueness of slugs by uploader - {'fields': ['uploader', 'slug'], - 'unique': True}] - def main_mediafile(self): pass From 8db03585a22904404543fe324c2c06b90471aed8 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Mon, 27 Jun 2011 20:05:01 -0500 Subject: [PATCH 17/23] Updating migrate.py to actually run the indexing commands --- mediagoblin/gmg_commands/migrate.py | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/mediagoblin/gmg_commands/migrate.py b/mediagoblin/gmg_commands/migrate.py index 9e01d51c..ab1a267b 100644 --- a/mediagoblin/gmg_commands/migrate.py +++ b/mediagoblin/gmg_commands/migrate.py @@ -16,6 +16,7 @@ from mediagoblin.db import migrations +from mediagoblin.db import util as db_util from mediagoblin.gmg_commands import util as commands_util @@ -27,8 +28,17 @@ def migrate_parser_setup(subparser): def migrate(args): mgoblin_app = commands_util.setup_app(args) - print "Applying migrations..." + # Clear old indexes + print "== Clearing old indexes... ==" + removed_indexes = db_util.remove_deprecated_indexes(mgoblin_app.db) + + for collection, index_name in removed_indexes: + print "Removed index '%s' in collection '%s'" % ( + index_name, collection) + + # Migrate + print "== Applying migrations... ==" for model_name in migrations.MIGRATE_CLASSES: model = getattr(mgoblin_app.db, model_name) @@ -38,4 +48,10 @@ def migrate(args): migration = model.migration_handler(model) migration.migrate_all(collection=model.collection) - print "... done." + # Add new indexes + print "== Adding new indexes... ==" + new_indexes = db_util.add_new_indexes(mgoblin_app.db) + + for collection, index_name in new_indexes: + print "Added index '%s' to collection '%s'" % ( + index_name, collection) From 1f7749995dbbc2b6063d93e59948e008e60567eb Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Mon, 27 Jun 2011 20:40:31 -0500 Subject: [PATCH 18/23] Documentation updates to indexes.py's docstring Includes information on how to deprecate indexes. --- mediagoblin/db/indexes.py | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/mediagoblin/db/indexes.py b/mediagoblin/db/indexes.py index bd97f9f2..bbcceb6d 100644 --- a/mediagoblin/db/indexes.py +++ b/mediagoblin/db/indexes.py @@ -17,9 +17,12 @@ """ Indexes for the local database. +To add new indexes +------------------ + Indexes are recorded in the following format: -INDEXES = { +ACTIVE_INDEXES = { 'collection_name': { 'identifier': { # key identifier used for possibly deprecating later 'index': [index_foo_goes_here]}} @@ -39,6 +42,21 @@ REQUIRED READING: - http://www.mongodb.org/display/DOCS/Indexing+Advice+and+FAQ +To remove deprecated indexes +---------------------------- + +Removing deprecated indexes is easier, just do: + +INACTIVE_INDEXES = { + 'collection_name': [ + 'deprecated_index_identifier1', 'deprecated_index_identifier2']} + +... etc. + +If an index has been deprecated that identifier should NEVER BE USED +AGAIN. Eg, if you previously had 'awesomepants_unique', you shouldn't +use 'awesomepants_unique' again, you should create a totally new name +or at worst use 'awesomepants_unique2'. """ from pymongo import ASCENDING, DESCENDING @@ -97,8 +115,4 @@ ACTIVE_INDEXES['users'] = USER_INDEXES # Deprecated indexes #################### -# @@: Do we really need to keep the index form if we're removing by -# key name? I guess it's helpful to keep the record... - - DEPRECATED_INDEXES = {} From 2527754202ea9530c9046270e63d71581923dc77 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Mon, 27 Jun 2011 20:48:35 -0500 Subject: [PATCH 19/23] Documenging index utils and adjusting how remove_deprecated_indexes gets arguments More specifically, we now just take a dictionary of lists, like: {'collection': ['index_identifier1', 'index_identifier2']} Previously we took something with more info like in add_new_indexes, but that extra info isn't really necessary. --- mediagoblin/db/util.py | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/mediagoblin/db/util.py b/mediagoblin/db/util.py index 219617ec..46f899f7 100644 --- a/mediagoblin/db/util.py +++ b/mediagoblin/db/util.py @@ -41,6 +41,16 @@ def add_new_indexes(database, active_indexes=ACTIVE_INDEXES): """ Add any new indexes to the database. + Args: + - database: pymongo or mongokit database instance. + - active_indexes: indexes to possibly add in the pattern of: + {'collection_name': { + 'identifier': { + 'index': [index_foo_goes_here], + 'unique': True}} + where 'index' is the index to add and all other options are + arguments for collection.create_index. + Returns: A list of indexes added in form ('collection', 'index_name') """ @@ -68,16 +78,21 @@ def remove_deprecated_indexes(database, deprecated_indexes=DEPRECATED_INDEXES): """ Remove any deprecated indexes from the database. + Args: + - database: pymongo or mongokit database instance. + - deprecated_indexes: the indexes to deprecate in the pattern of: + {'collection': ['index_identifier1', 'index_identifier2']} + Returns: A list of indexes removed in form ('collection', 'index_name') """ indexes_removed = [] - for collection_name, indexes in deprecated_indexes.iteritems(): + for collection_name, index_names in deprecated_indexes.iteritems(): collection = database[collection_name] collection_indexes = collection.index_information().keys() - for index_name, index_data in indexes.iteritems(): + for index_name in index_names: if index_name in collection_indexes: collection.drop_index(index_name) From a8923a7da3bb18f2a8b8058ecde6460b2ffdaab4 Mon Sep 17 00:00:00 2001 From: Caleb Forbes Davis V Date: Mon, 27 Jun 2011 23:49:57 -0500 Subject: [PATCH 20/23] removes messages.add_message from the global template context templates don't add messages. views are responsible for that. --- mediagoblin/util.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/mediagoblin/util.py b/mediagoblin/util.py index f0229300..a20e87c4 100644 --- a/mediagoblin/util.py +++ b/mediagoblin/util.py @@ -106,8 +106,6 @@ def get_jinja_env(template_loader, locale): mg_globals.translations.ngettext) # All templates will know how to ... - # ... add a new message to the message queue - template_env.globals['add_message'] = messages.add_message # ... fetch all waiting messages and remove them from the queue template_env.globals['fetch_messages'] = messages.fetch_messages From 9f094beaafa2b5cefcd1812b692421cb0e1718e6 Mon Sep 17 00:00:00 2001 From: Caleb Forbes Davis V Date: Tue, 28 Jun 2011 02:35:44 -0500 Subject: [PATCH 21/23] adds message queue unit testing --- mediagoblin/tests/test_messages.py | 44 ++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 mediagoblin/tests/test_messages.py diff --git a/mediagoblin/tests/test_messages.py b/mediagoblin/tests/test_messages.py new file mode 100644 index 00000000..4cd9381a --- /dev/null +++ b/mediagoblin/tests/test_messages.py @@ -0,0 +1,44 @@ +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011 Free Software Foundation, Inc +# +# 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 . + +from mediagoblin.messages import fetch_messages, add_message +from mediagoblin.tests.tools import setup_fresh_app +from mediagoblin import util + + +@setup_fresh_app +def test_messages(test_app): + """ + Added messages should show up in the request.session, + fetched messages should be the same as the added ones, + and fetching should clear the message list. + """ + # Aquire a request object + test_app.get('/') + context = util.TEMPLATE_TEST_CONTEXT['mediagoblin/root.html'] + request = context['request'] + + # The message queue should be empty + assert request.session.get('messages', []) == [] + + # Adding a message should modify the session accordingly + add_message(request, 'herp_derp', 'First!') + test_msg_queue = [{'text': 'First!', 'level': 'herp_derp'}] + assert request.session['messages'] == test_msg_queue + + # fetch_messages should return and empty the queue + assert fetch_messages(request) == test_msg_queue + assert request.session.get('messages') == [] From 604ed842b38da66ed3986792f5e7fe6a6ed5eadf Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Tue, 28 Jun 2011 20:54:40 -0500 Subject: [PATCH 22/23] Styling for the messaging list items. A rainbow of messages! --- mediagoblin/static/css/base.css | 41 +++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/mediagoblin/static/css/base.css b/mediagoblin/static/css/base.css index e39770d5..55410bca 100644 --- a/mediagoblin/static/css/base.css +++ b/mediagoblin/static/css/base.css @@ -73,6 +73,47 @@ label { padding-bottom:74px; } +ul.mediagoblin_messages { + list-style:none inside; + color:#393932; + margin:2px; + padding:2px; +} + +ul.mediagoblin_messages li { + background-color:#d4d4d4; + border-style:solid; + border-width:3px; + border-color:#959595; + margin:5px; + padding:8px; +} + +ul.mediagoblin_messages li.message_success { + background-color: #88d486; + border-color: #5bba59; +} + +ul.mediagoblin_messages li.message_warning { + background-color: #d4c686; + border-color: #baa959; +} + +ul.mediagoblin_messages li.message_error { + background-color: #d48686; + border-color: #ba5959; +} + +ul.mediagoblin_messages li.message_info { + background-color: #86b9d4; + border-color: #5998ba; +} + +ul.mediagoblin_messages li.message_debug { + background-color: #aa86d4; + border-color: #8659ba; +} + a.mediagoblin_logo { width:34px; height:25px; From b0d835fcd0f46025eee6c839e9bf26f513543898 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Tue, 28 Jun 2011 20:56:06 -0500 Subject: [PATCH 23/23] Making the messages conform to the 960.gx widths --- .../templates/mediagoblin/utils/messages.html | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/mediagoblin/templates/mediagoblin/utils/messages.html b/mediagoblin/templates/mediagoblin/utils/messages.html index a8d9c37e..52d03daa 100644 --- a/mediagoblin/templates/mediagoblin/utils/messages.html +++ b/mediagoblin/templates/mediagoblin/utils/messages.html @@ -19,10 +19,14 @@ {# Display any queued messages #} {% set messages = fetch_messages(request) %} {% if messages %} -
    - {% for msg in messages %} -
  • {{ msg.text }}
    • - {% endfor %} -
+
+
+
    + {% for msg in messages %} +
  • {{ msg.text }}
    • + {% endfor %} +
+
+
{% endif %}