Merge pull request #2 from ricardodani/master

Solving some hardcoded url`s and the possibilite to use this with a admin site mapped as `/`.

Author: RobCombs

locking/admin.py

@@ -3,25 +3,25 @@
 from datetime import datetime
 
 from django.contrib import admin
-from django.conf import settings
 from django.core.urlresolvers import reverse
 from django.utils.translation import ugettext as _
 from django import forms
 from django.contrib.contenttypes.models import ContentType
 
 from locking import LOCK_TIMEOUT, views
 from locking.models import Lock
+from locking import settings as _s
 
 class LockableAdmin(admin.ModelAdmin):
 
     class Media:
-      js = ( 'http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js', 
-            'static/locking/js/jquery.url.packed.js',
-            "/admin/ajax/variables.js",
-            "static/locking/js/admin.locking.js?v=1")
-
-      css = {"all": ("static/locking/css/locking.css",)
-      }
+        js = (
+            'http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js', 
+            _s.STATIC_URL + 'locking/js/jquery.url.packed.js',
+            _s.ADMIN_URL + "ajax/variables.js",
+            _s.STATIC_URL + "locking/js/admin.locking.js?v=1"
+        )
+        css = {"all": (_s.STATIC_URL + 'locking/css/locking.css',)}
 
     def get_form(self, request, obj, *args, **kwargs):
         form = super(LockableAdmin, self).get_form(request, *args, **kwargs)
@@ -33,16 +33,20 @@ def changelist_view(self, request, extra_context=None):
         # we need the request objects in a few places where it's usually not present, 
         # so we're tacking it on to the LockableAdmin class
         self.request = request
-        return super(LockableAdmin, self).changelist_view(request, extra_context)
+        return super(LockableAdmin, self).changelist_view(request,
+                                                          extra_context)
 
     def save_model(self, request, obj, form, change, *args, **kwargs):
 
-        super(LockableAdmin, self).save_model(request, obj, form, change, *args, **kwargs)
+        super(LockableAdmin, self).save_model(request, obj, form, change,
+                                              *args, **kwargs)
 
         try:
             # object creation doesn't need/have locking in place
             content_type = ContentType.objects.get_for_model(obj)
-            obj = Lock.objects.get(entry_id=obj.id, app=content_type.app_label, model=content_type.model)
+            obj = Lock.objects.get(entry_id=obj.id,
+                                   app=content_type.app_label,
+                                   model=content_type.model)
             obj.unlock_for(request.user)
             obj.save()
         except:
@@ -51,8 +55,9 @@ def save_model(self, request, obj, form, change, *args, **kwargs):
 
     def get_lock_for_admin(self_obj, obj):
         ''' 
-        returns the locking status along with a nice icon for the admin interface 
-        use in admin list display like so: list_display = ['title', 'get_lock_for_admin']
+        returns the locking status along with a nice icon for the admin
+        interface use in admin list display like so:
+        list_display = ['title', 'get_lock_for_admin']
         '''
 
         locked_by = ''
@@ -61,7 +66,9 @@ def get_lock_for_admin(self_obj, obj):
 
         content_type = ContentType.objects.get_for_model(obj)
         try:
-            lock = Lock.objects.get(entry_id=obj.id, app=content_type.app_label, model=content_type.model)
+            lock = Lock.objects.get(entry_id=obj.id,
+                                    app=content_type.app_label,
+                                    model=content_type.model)
             class_name = 'locked'
             locked_by = lock.locked_by.username
             output = str(obj.id)
@@ -74,17 +81,25 @@ def get_lock_for_admin(self_obj, obj):
             locked_until = _("Still locked for %s more minute(s) by %s.") \
                 % (minutes_remaining, lock.locked_by)
             if self_obj.request.user == lock.locked_by: 
-                locked_until_self = _("You have a lock on this content for %s more minute(s).") \
-                    % (minutes_remaining)
-                locked_until = '<img src="%sstatic/locking/img/page_edit.png" title="%s" />' \
-                    % (settings.MEDIA_URL, locked_until_self)
+                locked_until_self = _(
+                    "You have a lock on this content for %s more minute(s)."
+                    ) % (minutes_remaining)
+                locked_until = '''
+                    <img src="%slocking/img/page_edit.png"
+                    title="%s" />''' % (_s.STATIC_URL, locked_until_self)
             else:
-                locked_until = _("Still locked for %s more minute(s) by %s.") \
-                    % (minutes_remaining, lock.locked_by)
-                locked_until = '<img src="%sstatic/locking/img/lock.png" title="%s" />' \
-                    % (settings.MEDIA_URL, locked_until)
-            full_name = "%s %s" % (lock.locked_by.first_name,lock.locked_by.last_name)
-            return u'<a href="#" id=%s class="lock-status %s" title="Locked By: %s">%s%s</a>' % (output, class_name, full_name, locked_until, " " + locked_by)
+                locked_until = _(
+                    "Still locked for %s more minute(s) by %s."
+                    ) % (minutes_remaining, lock.locked_by)
+                locked_until = '''
+                    <img src="%slocking/img/lock.png" title="%s" />'''\
+                    % (_s.STATIC_URL, locked_until)
+            full_name = "%s %s" % (
+                lock.locked_by.first_name,lock.locked_by.last_name)
+            return u'''
+                <a href="#" id=%s class="lock-status %s"
+                   title="Locked By: %s">%s%s</a>''' % (output, class_name,
+                                     full_name, locked_until, " " + locked_by)
         else:
             return ''
 

locking/media/locking/js/admin.locking.js

@@ -84,9 +84,17 @@ locking.admin = function() {
 	try {
 		settings = locking;
 		// Get url parts.
-		var app = $.url.segment(1);
-		var model = $.url.segment(2);
-		var id = $.url.segment(3);
+        var adm_url = settings.admin_url;
+		var pathname = window.location.pathname;
+        if (pathname.indexOf(adm_url) == 0 && adm_url.length > 0) {
+            var app = $.url.segment(1);
+            var model = $.url.segment(2);
+            var id = $.url.segment(3);
+        } else {
+            var app = $.url.segment(0);
+            var model = $.url.segment(1);
+            var id = $.url.segment(2);
+        }
 		var base_url = settings.base_url + "/" + [app, model, id].join("/");
 		unlock_click_event(base_url);
 
@@ -252,4 +260,4 @@ try {
 }
 
 // End wrap.
-})(jQuery, locking);
+})(jQuery, locking);

locking/settings.py

@@ -0,0 +1,5 @@
+from django.conf import settings
+
+MEDIA_URL = getattr(settings, 'MEDIA_URL', '/media/')
+ADMIN_URL = getattr(settings, 'ADMIN_URL', '/admin/')
+STATIC_URL = getattr(settings, 'STATIC_URL', '/static/')

locking/views.py

@@ -7,6 +7,7 @@
 from locking.decorators import user_may_change_model, is_lockable, log
 from locking import utils, LOCK_TIMEOUT, logger
 from locking.models import Lock, ObjectLockedError
+from locking import settings as _s
 
 """
 These views are called from javascript to open and close assets (objects), in order
@@ -74,10 +75,13 @@ def is_locked(request, app, model, id):
         return HttpResponse(status=200)
 @log
 def js_variables(request):
-	response = "var locking = " + simplejson.dumps({
-		'base_url': "/".join(request.path.split('/')[:-1]),
-		'timeout': LOCK_TIMEOUT,
-		'time_until_expiration': settings.LOCKING['time_until_expiration'],
+    response = "var locking = " + simplejson.dumps({
+        'base_url': "/".join(request.path.split('/')[:-1]),
+        'timeout': LOCK_TIMEOUT,
+        'time_until_expiration': settings.LOCKING['time_until_expiration'],
         'time_until_warning': settings.LOCKING['time_until_warning'],
-		})
-	return HttpResponse(response, mimetype='application/json')
+        'admin_url': "/".join(_s.ADMIN_URL.split('/')[:-1]),
+    })
+
+    return HttpResponse(response, mimetype='application/json')
+

setup.py

@@ -1,6 +1,6 @@
 import os
 from setuptools import setup, find_packages
-version = '0.3.1'
+version = '0.3.2'
 README = os.path.join(os.path.dirname(__file__), 'README.md')
 long_description = open(README).read()
 setup(name='django-locking',