Changeset 2037

Timestamp:

06/17/09 09:19:14 (9 months ago)

Author:

JensDiemer

Message:

• change the way extra head content would be stored: So ajax view can use {% extrahead %}.
• merge some JavaScript? code
• add needfull shortcut for "ajax+normal response" views.

Location:

branches/0.9/pylucid_project

Files:

• apps/pylucid/defaulttags/extraheadBlock.py (modified) (2 diffs)
• apps/pylucid/shortcuts.py (added)
• apps/pylucid/system/extrahead.py (added)
• apps/pylucid/system/pylucid_objects.py (modified) (2 diffs)
• media/PyLucid/pylucid_js_tools.js (modified) (1 diff)
• pylucid_plugins/admin_menu/templates/admin_menu/admin_top_menu.html (modified) (2 diffs)
• pylucid_plugins/admin_menu/views.py (modified) (1 diff)
• pylucid_plugins/auth/templates/auth/input_username.html (modified) (1 diff)
• pylucid_plugins/auth/templates/auth/login_link.html (modified) (1 diff)
• pylucid_plugins/auth/templates/auth/logout_link.html (modified) (1 diff)
• pylucid_plugins/auth/views.py (modified) (9 diffs)
• pylucid_plugins/extrahead/context_middleware.py (modified) (3 diffs)
• pylucid_plugins/page_admin/templates/page_admin/edit_page_form.html (modified) (2 diffs)
• pylucid_plugins/page_admin/views.py (modified) (5 diffs)

branches/0.9/pylucid_project/apps/pylucid/defaulttags/extraheadBlock.py

@@ -6 +6 @@
     
     Simple django template block tag. "Redirect" extra head content
-    into pylucid_plugin.head_files.context_middleware
+    into request.PYLUCID.extrahead
+    This data would be inserted with pylucid_plugin.extrahead.context_middleware
     
     PyLucid plugins should use {% extrahead %} block tag in plugin template for
@@ -40 +41 @@
             raise RuntimeError("Plugin must use RequestContext() or request.PYLUCID.context !")
          
-        head_files = request.PYLUCID.context["context_middlewares"]["extrahead"]
-        head_files.add_content(output)
+        extrahead = request.PYLUCID.extrahead
+        extrahead.append(output)
         return u""

branches/0.9/pylucid_project/apps/pylucid/system/pylucid_objects.py

@@ -1 +1 @@
 # coding:utf-8
 
+"""
+    PyLucid objects
+    ~~~~~~~~~~~~~~~
+    
+    Some need full objects attached to the current request object in pylucid.views.
+    
+    see also: http://www.pylucid.org/_goto/187/PyLucid-objects/
+
+    Last commit info:
+    ~~~~~~~~~~~~~~~~~
+    $LastChangedDate: $
+    $Rev: $
+    $Author: $
+
+    :copyleft: 2009 by the PyLucid team, see AUTHORS for more details.
+    :license: GNU GPL v3 or above, see LICENSE for more details.
+"""
+
 from pylucid.models import Language
+from pylucid.system import extrahead
 from pylucid.preference_forms import SystemPreferencesForm
 
 class PyLucidRequestObjects(object):
-    """
-    PyLucid request objects
-    see also: http://www.pylucid.org/_goto/187/PyLucid-objects/
-    """
+    """ PyLucid request objects """
     def __init__(self):
         self.system_preferences = SystemPreferencesForm().get_preferences()
@@ -14 +30 @@
         self.default_lang_code = default_lang_code
         self.default_lang_entry = Language.objects.get(code=default_lang_code)
+        
+        # Storing extra html head code from plugins, used in:
+        # pylucid.defaulttags.extraheadBlock - redirect {% extrahead %} block tag content
+        # pylucid_plugin.extrahead.context_middleware - insert the data into the global page
+        self.extrahead = extrahead.ExtraHead()
+        
         # objects witch will be set later:
         #self.pagetree - The current PageTree model instance

branches/0.9/pylucid_project/media/PyLucid/pylucid_js_tools.js

@@ -16 +16 @@
 
 
+function pylucid_ajax_form_view(form_id) {
+    /*************************************************************************
+    PyLucid ajax form view.
+    
+    Don't send the form and get a complete new rendered page. Send the form
+    via ajax post and replace the #page_content with the html response.
+    
+    usage e.g.:
+    ----------------------------------------------------------------------
+            $(document).ready(function(){
+                // simply bind the form with the id:
+                pylucid_ajax_form_view('#form_id');
+            });
+    ----------------------------------------------------------------------
+    *************************************************************************/
+    $(form_id).bind('submit', function() {
+        
+        $("#page_content").html('<h2>loading...</h2>');
+        $("#page_content").animate({opacity: 0.3}, 500 );
+
+        var form = $(this);
+        var form_data = form.serialize();
+        log("form data:" + form_data);
+        
+        var url = encodeURI(form.attr('action'));
+        log("send form to url:" + url);
+        
+        var load_normal_link = true;
+        
+        $.ajax({
+                async: false,
+            type: "POST",
+            url: url,
+            data: form_data,
+            dataType: "html",
+            
+            success: function(form_html){
+                        log("ajax post response success.");
+                $("#page_content").html(form_html);
+                $("#page_content").animate({opacity: 1}, 500 );
+                load_normal_link = false;
+            },
+            error: function(XMLHttpRequest){
+                log("ajax get response error!");
+                // Display the complete Traceback html page
+                log(XMLHttpRequest);
+                var response_text = XMLHttpRequest.responseText;
+                log("response_text: '" + response_text + "'");
+                if (!response_text) {
+                        document.write("<h1>ajax response error</h1>");
+                } else {
+                        document.write(response_text);
+                }
+                load_normal_link = true;
+            }
+        });       
+        return load_normal_link; // <-- important: Don't send the form in normal way.
+    }); 
+}
+
+
 
 function get_pylucid_ajax_view(url) {
     /*************************************************************************
-        PyLucid ajax replace function
-        
-        usage e.g.:
-        ----------------------------------------------------------------------
-            $(document).ready(function(){
-                $("#link_id").click(function(){
-                    return get_pylucid_ajax_view("{{ ajax_get_view_url }}");
-                });
+    PyLucid ajax get view replace.
+    
+    Don't render the complete page again. Simply get the new content via ajax
+    and replace #page_content with it.
+    
+    usage e.g.:
+    ----------------------------------------------------------------------
+        $(document).ready(function(){
+            $("#link_id").click(function(){
+                return get_pylucid_ajax_view("{{ ajax_get_view_url }}");
             });
-        ----------------------------------------------------------------------
-        or:
-        ----------------------------------------------------------------------
-        <a href="{{ url }}" onclick="return get_pylucid_ajax_view('{{ ajax_url }}');">foo</a>
-        ----------------------------------------------------------------------
+        });
+    ----------------------------------------------------------------------
+    or:
+    ----------------------------------------------------------------------
+    <a href="{{ url }}" onclick="return get_pylucid_ajax_view('{{ ajax_url }}');">foo</a>
+    ----------------------------------------------------------------------
     *************************************************************************/
     $("#page_content").html('<h2>loading...</h2>');

branches/0.9/pylucid_project/pylucid_plugins/admin_menu/templates/admin_menu/admin_top_menu.html

@@ -9 +9 @@
 <script type="text/javascript" src="{{ PyLucid_media_url }}superfish/superfish.js" onerror="JavaScript:alert('{{ PyLucid_media_url }}superfish/superfish.js');" ></script>
 <script type="text/javascript" src="{{ PyLucid_media_url }}superfish/pylucid_superfish_init.js" onerror="JavaScript:alert('{{ PyLucid_media_url }}superfish/pylucid_superfish_init.js');" ></script>
-<script type="text/javascript" src="{{ PyLucid_media_url }}pylucid_js_tools.js" onerror="JavaScript:alert('{{ PyLucid_media_url }}pylucid_js_tools.js');" ></script>
 <style type="text/css">
 <!--
@@ -26 +25 @@
     <li class="current">{% lucidTag auth %}</li>
     <li>
-        <li><a href="{{ edit_page_link }}" title="edit inline" id="edit_page" onclick="return get_pylucid_ajax_view('{{ edit_page_ajax}}');">{% trans 'edit page' %}</a></li>
+        <li><a href="{{ edit_page_link }}" title="edit inline" id="edit_page" onclick="return get_pylucid_ajax_view('{{ edit_page_link }}');">{% trans 'edit page' %}</a></li>
         <ul>
             <li><a href="{{ edit_admin_panel_link }}">edit in admin panel</a></li>

branches/0.9/pylucid_project/pylucid_plugins/admin_menu/views.py

@@ -31 +31 @@
         
         "edit_page_link": "?page_admin=inline_edit",
-        "edit_page_ajax": "?page_admin=get_ajax_form",
         
         "edit_admin_panel_link": edit_admin_panel_link,

branches/0.9/pylucid_project/pylucid_plugins/auth/templates/auth/input_username.html

@@ -2 +2 @@
 
 {% block plugin_content %}
-{# We can't use extrahead block here, because it's used in ajax view, too. #}
+
+{% extrahead %}
 <script type="text/javascript">
-
 $(document).ready(function(){
     log("input username ready");
     $("#id_username").focus();
     
-    $('#username_form').bind('submit', function() {
-        // get the input password form via ajax
-        $("#page_content").html('<h2>loading...</h2>');
-        $("#page_content").animate({opacity: 0.3}, 500 );
-    
-        log("continue login...");
-
-        var form = $(this);
-        var form_data = form.serialize();
-        log("form data:" + form_data);
-        
-        var url = encodeURI(form.attr('action'));
-        log("form url:" + url);
-        
-            $.post(url, form_data,
-                function(form_html){
-                    log("ajax get success.");
-                    $("#page_content").html(form_html);
-                    $("#page_content").animate({opacity: 1}, 500 );
-                }
-            );
-        
-        return false; // <-- important!
-    });    
+    pylucid_ajax_form_view('#username_form'); // send username form and get the input password form via ajax
 });
 </script>
+{% endextrahead %}
 
 <fieldset><legend>PyLucid <a href="http://www.pylucid.org/_goto/8/JS-SHA-Login/" title="What is the PyLucid JS-SHA-LogIn?">JS-SHA-LogIn</a> - step 1</legend>

branches/0.9/pylucid_project/pylucid_plugins/auth/templates/auth/login_link.html

@@ -2 +2 @@
 
 {% block plugin_content %}
-<a href="{{ login_url }}" id="login_link" onclick="return get_pylucid_ajax_view('{{ login_url_ajax }}');">{% trans 'Log in' %}</a>
+<a href="{{ url }}" id="login_link" onclick="return get_pylucid_ajax_view('{{ url }}');">{% trans 'Log in' %}</a>
 {% endblock %}

branches/0.9/pylucid_project/pylucid_plugins/auth/templates/auth/logout_link.html

@@ -1 @@
-<a href="{{ logout_url }}">{% trans 'Log out' %} [{{ request.user.username }}]</a>
+<a href="{{ url }}">{% trans 'Log out' %} [{{ request.user.username }}]</a>

branches/0.9/pylucid_project/pylucid_plugins/auth/views.py

@@ -5 +5 @@
 from django.template import RequestContext
 from django.http import HttpResponseRedirect
-from django.shortcuts import render_to_response
 from django.utils.translation import ugettext as _
 from django.template.loader import render_to_string
+
+from pylucid.shortcuts import render_pylucid_response
 
 from pylucid_project.utils import crypt
@@ -25 +26 @@
 
 
+
+
+
 def lucidTag(request):
-    # TODO: Use internal SHA-Login plugin views, if implemented:
+    """ Create login/logout link """
     if request.user.is_authenticated():
         # admin_logout reverse is still broken in django, see:
@@ -34 +38 @@
         #url = reverse("admin_index") + "logout/" # TODO: Update this if django is bugfixed
         template_name = "auth/logout_link.html"
-        context = {"logout_url": "?auth=logout"}
+        url = "?auth=logout"
     else:
         template_name = "auth/login_link.html"
-        #url = reverse("admin_index") # django admin panel index page
-        context = {
-            "login_url": "?auth=login",
-            "login_url_ajax": "?auth=get_login_form",
-        }
-    
-    return render_to_string(template_name, context, context_instance=RequestContext(request))
+        url = "?auth=login"
+           
+    return render_to_string(template_name, {"url": url}, context_instance=RequestContext(request))
 
 
@@ -66 +66 @@
 
 
-def _plaintext_login(request, context, username, next_url, render_function):
+def _plaintext_login(request, context, username, next_url):
     """ input the password and login if auth ok """
     if "password" in request.POST:
@@ -79 +79 @@
     
     # return a string for replacing the normal cms page content
-    return render_function('auth/plaintext_login.html', context)
-
-
-    
-def _sha_login(request, context, user, next_url, render_function):
+    return render_pylucid_response(request, 'auth/plaintext_login.html', context)
+
+
+    
+def _sha_login(request, context, user, next_url):
     """
     Login via JS-SHA-Login.
@@ -145 +145 @@
 
     # return a string for replacing the normal cms page content
-    return render_function('auth/input_password.html', context, context_instance=RequestContext(request))
-
-
-def _login_view(request, form_url, next_url, render_function):
+    return render_pylucid_response(request, 'auth/input_password.html', context,
+        context_instance=RequestContext(request)
+    )
+
+
+def _login_view(request, form_url, next_url):
     if DEBUG:
         request.page_msg(
@@ -168 +170 @@
             
             if "plaintext_login" in request.POST:
-                return _plaintext_login(request, context, user.username, next_url, render_function)
+                return _plaintext_login(request, context, user.username, next_url)
             else:
-                return _sha_login(request, context, user, next_url, render_function)
+                return _sha_login(request, context, user, next_url)
     else:
         username_form = UsernameForm()
@@ -177 +179 @@
     
     # return a string for replacing the normal cms page content
-    return render_function('auth/input_username.html', context)
+    return render_pylucid_response(request, 'auth/input_username.html', context)
 
 
@@ -185 +187 @@
     """
     next_url = request.path
-#    import time
-#    time.sleep(0.5)
     action = request.GET["auth"]
     if action=="login":
         form_url = request.path + "?auth=login" # FIXME: How can we add the GET Parameter?
-        return _login_view(request, form_url, next_url, render_function=render_to_string)
-    elif action=="get_login_form":
-        form_url = request.path + "?auth=get_login_form" # FIXME: How can we add the GET Parameter?
-        return _login_view(request, form_url, next_url, render_function=render_to_response)
+        return _login_view(request, form_url, next_url)
     elif action=="logout":
         return _logout_view(request, next_url)

branches/0.9/pylucid_project/pylucid_plugins/extrahead/context_middleware.py

@@ -5 +5 @@
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    Stores extra html head content via PyLucid context middleware.
-    It's used by pylucid.defaulttags.extraheadBlock.
+    replace <!-- ContextMiddleware extrahead --> in the global page template with
+    all extra head html code, stored in request.PYLUCID.extrahead (pylucid.system.extrahead)
     
-    PyLucid plugins should use {% extrahead %} block tag in plugin template for
-    insert e.g. CSS/JS file links into html head.
+    Add all headfile links from pagetree.design.headfiles m2m.
+    
+    PyLucid plugins should use {% extrahead %} block tag (pylucid.defaulttags.extraheadBlock)
+    in plugin template for insert e.g. CSS/JS file links into html head.
 
     Last commit info:
@@ -29 +31 @@
 
 
-FILEPATH_SPLIT = "pylucid_project"
-
-SKIP_MODULES = [
-    os.path.join("django", "template"),
-    os.path.join("django", "shortcuts"),
-    os.path.join("extrahead", "context_middleware")
-]
-
-DEBUG_INFO = """\
-<!-- extrahead from %(fileinfo)s - START -->
-%(content)s
-<!-- extrahead from %(fileinfo)s - END -->"""
-
-
 class ContextMiddleware(object):
-    """
-    Simple store extra html head content from plugins.
-    """
+    """ replace <!-- ContextMiddleware extrahead --> in the global page template """
     def __init__(self, request, context):
         self.request = request
-        if settings.DEBUG:
-            # Turn debug mode in JavaScript on
-            self.data = DEBUG_INFO % {
-                "fileinfo": os.path.basename(__file__),
-                "content": '<script type="text/javascript">var debug=true;log("debug is on");</script>'
-            }
-            self.data += "\n" 
-        else:
-            self.data = ""
-        
-    def add_content(self, content):
-        content = content.strip()
-        if settings.DEBUG:
-            # Add debug info around content.
-            fileinfo = self._get_fileinfo()
-            content = DEBUG_INFO % {"fileinfo": fileinfo, "content": content}
-            
-        self.data += content + "\n"
-        
+        self.extrahead = request.PYLUCID.extrahead # pylucid.system.extrahead
+                            
     def _add_pagetree_headfiles(self):
+        """ add all headfile links used in the current design. """
         pagetree = self.request.PYLUCID.pagetree
         design = pagetree.design
@@ -74 +44 @@
         headfiles = design.headfiles.all()
         
-        headfilelinks = []
         for headfile in headfiles:
             # Get a instance from pylucid.system.headfile.HeadfileLink():
             headfilelink = headfile.get_headfilelink()
             head_tag = headfilelink.get_head_tag()
-            headfilelinks.append(head_tag)
-        
-        self.add_content("\n".join(headfilelinks))
+            self.extrahead.append(head_tag)
         
     def render(self):
+        """ return all extra head content with all headfiles from current used design """
         self._add_pagetree_headfiles()
-        return self.data
-    
-    def _get_fileinfo(self):
-        """
-        return fileinfo: Where from the announcement comes?
-        """
-        def skip(filepath):
-            for ignore_path in SKIP_MODULES:
-                if ignore_path in filepath:
-                    return True
-            return False
-        
-        try:    
-            fileinfo = []
-            step = 0
-            for stack_frame in inspect.stack():
-                filepath = stack_frame[1]              
-                lineno = stack_frame[2]
+        return "\n".join(self.extrahead)
 
-                if skip(filepath) or FILEPATH_SPLIT not in filepath:
-                    continue
-                
-                filepath = "..." + filepath.split(FILEPATH_SPLIT,1)[1]
-                
-                fileinfo.append("%s line %s" % (filepath, lineno))
-                if step>=1:
-                    break
-                step += 1
-            return " | ".join(fileinfo)
-        except Exception, e:
-            return "(inspect Error: %s)" % e

branches/0.9/pylucid_project/pylucid_plugins/page_admin/templates/page_admin/edit_page_form.html

@@ -1 +1 @@
 {% extends "pylucid/css_anchor_div.html" %}
+
 
 {% block plugin_content %}
 
-{# We can't use extrahead block here, because it's used in ajax view, too. #}
+{% extrahead %}
 <script type="text/javascript">
 $(document).ready(function(){
     $("#preview_fieldset").hide();
     
+    pylucid_ajax_form_view('#edit_page_form');
+        
     $("#preview").click(function() {
         $("#edit_page_preview").html("<h2>loading...</h2>");
@@ -22 +25 @@
             
         });
-      return false; // The browser submit the form, if true
+      return false; // <-- important: Don't send the form in normal way.
     });
 });
 </script>
+{% endextrahead %}
 
 <fieldset id="preview_fieldset">

branches/0.9/pylucid_project/pylucid_plugins/page_admin/views.py

@@ -5 +5 @@
 from django.conf import settings
 from django.template import RequestContext
-from django.shortcuts import render_to_response
 from django.utils.translation import ugettext as _
 from django.core.exceptions import PermissionDenied
-from django.template.loader import render_to_string
 from django.http import HttpResponse, HttpResponseRedirect
 
 from pylucid.markup.converter import apply_markup
+from pylucid.shortcuts import render_pylucid_response
 
 from page_admin.forms import EditPageForm
@@ -35 +34 @@
 
 
-def _edit_page(request, render_function):
+def _edit_page(request, form_url):
     check_permissions(request, EDIT_PERMISSIONS)
     
@@ -53 +52 @@
     
     context = {
-        "form_url": "%s?page_admin=inline_edit" % request.path,
+        "form_url": form_url,
         "abort_url": request.path,
         "preview_url": "%s?page_admin=preview" % request.path,
@@ -64 +63 @@
         "pagemeta_instance": pagemeta_instance,
     }
-    return render_function('page_admin/edit_page_form.html', context, 
+    return render_pylucid_response(request, 'page_admin/edit_page_form.html', context, 
         context_instance=RequestContext(request)
     )
@@ -89 +88 @@
     if action=="inline_edit":
         # replace the page content with the edit page form
-        return _edit_page(request, render_function=render_to_string)
-    elif action=="get_ajax_form":
-        # return the edit page form only, for inserting it via jQuery
-        return _edit_page(request, render_function=render_to_response)
+        form_url = "%s?page_admin=inline_edit" % request.path
+        return _edit_page(request, form_url)
     elif action=="preview":
         # preview via jQuery