Bug 376673: Add a simple version of the bug entry form (enter_bug.cgi)

js/TUI.js

@@ -16,153 +16,93 @@
  * Rights Reserved.
  * 
  * Contributor(s): Dennis Melentyev <dennis.melentyev@infopulse.com.ua>
+ *                 Max Kanat-Alexander <mkanat@bugzilla.org>
  */
 
- /* This file provides JavaScript functions to be included once one wish
-  * to add a hide/reveal/collapse per-class functionality
-  *
-  * 
-  * This file contains hide/reveal API for customizable page views
-  * TUI stands for Tweak UI.
-  *
-  * See bug 262592 for usage examples.
-  * 
-  * Note: this interface is experimental and under development.
-  * We may and probably will make breaking changes to it in the future.
-  */
-
-  var TUIClasses = new Array;
-  var TUICookiesEnabled = -1;
+/* This file provides JavaScript functions to be included when one wishes
+ * to show/hide certain UI elements, and have the state of them being
+ * shown/hidden stored in a cookie.
+ * 
+ * TUI stands for Tweak UI.
+ *
+ * Requires js/util.js and the YUI Dom and Cookie libraries.
+ *
+ * See template/en/default/bug/create/create.html.tmpl for a usage example.
+ */
 
-  // Internal function to demangle cookies
-  function TUI_demangle(value) {
-    var pair;
-    var pairs = value.split(",");
-    for (i = 0; i < pairs.length; i++) {
-      pair = pairs[i].split(":");
-      if (pair[0] != null && pair[1] != null)
-        TUIClasses[pair[0]] = pair[1];
-    }
-  }
+var TUI_HIDDEN_CLASS = 'bz_tui_hidden';
+var TUI_COOKIE_NAME  = 'TUI';
 
- /*  TUI_tweak: Function to redraw whole document. 
-  *  Also, initialize TUIClasses array with defaults, then override it 
-  *  with values from cookie
-  */
+var TUI_alternates = new Array();
 
-  function TUI_tweak( cookiesuffix, classes  ) {
-    var dc = document.cookie;
-    var begin = -1;
-    var end = 0;
+/** 
+ * Hides a particular class of elements if they are shown, 
+ * or shows them if they are hidden. Then it stores whether that
+ * class is now hidden or shown.
+ *
+ * @param className   The name of the CSS class to hide.
+ */
+function TUI_toggle_class(className) {
+    var elements = YAHOO.util.Dom.getElementsByClassName(className);
+    for (var i = 0; i < elements.length; i++) {
+        bz_toggleClass(elements[i], TUI_HIDDEN_CLASS);
+    }
+    _TUI_save_class_state(elements, className);
+    _TUI_toggle_control_link(className);
+}
 
-    // Register classes and their defaults
-    TUI_demangle(classes);
 
-    if (TUICookiesEnabled > 0) {
-      // If cookies enabled, process them
-      TUI_demangle(TUI_getCookie(cookiesuffix));
-    }
-    else if (TUICookiesEnabled == -1) {
-      // If cookies availability not checked yet since browser does 
-      // not has navigator.cookieEnabled property, let's check it manualy
-      var cookie = TUI_getCookie(cookiesuffix);
-      if (cookie.length == 0)
-      {
-        TUI_setCookie(cookiesuffix);
-	// Cookies are definitely disabled for JS.
-        if (TUI_getCookie(cookiesuffix).length == 0)
-          TUICookiesEnabled = 0;
-        else
-          TUICookiesEnabled = 1;
-      }
-      else {
-        // Have cookie set, pretend to be able to reset them later on
-        TUI_demangle(cookie);
-        TUICookiesEnabled = 1;
-      }
-    }
-      
-    if (TUICookiesEnabled > 0) {
-      var els = document.getElementsByTagName('*');
-      for (i = 0; i < els.length; i++) {
-        if (null != TUIClasses[els[i].className]) {
-          TUI_apply(els[i], TUIClasses[els[i].className]);
+/**
+ * Specifies that a certain class of items should be hidden by default,
+ * if the user doesn't have a TUI cookie.
+ * 
+ * @param className   The class to hide by default.
+ */
+function TUI_hide_default(className) {
+    YAHOO.util.Event.onDOMReady(function () {
+        if (!YAHOO.util.Cookie.getSub('TUI', className)) {
+            TUI_toggle_class(className);
         }
-      }
-    }
-    return;
-  }
+    });
+}
 
-  // TUI_apply: Function to draw certain element. 
-  // Receives element itself and style value: hide, reveal or collapse
+function _TUI_toggle_control_link(className) {
+    var link = document.getElementById(className + "_controller");
+    var original_text = link.innerHTML;
+    link.innerHTML = TUI_alternates[className];
+    TUI_alternates[className] = original_text;
+}
 
-  function TUI_apply(element, value) {
-    if (TUICookiesEnabled > 0 && element != null) {
-      switch (value)
-      {
-        case 'hide':
-          element.style.visibility="hidden";
-          break;
-        case 'collapse':
-          element.style.visibility="hidden";
-          element.style.display="none";
-          break;
-        case 'reveal': // Shown item must expand
-        default:     // The default is to show & expand
-          element.style.visibility="visible";
-          element.style.display="";
-          break;
-      }
+function _TUI_save_class_state(elements, aClass) {
+    // We just check the first element to see if it's hidden or not, and
+    // consider that all elements are the same.
+    if (YAHOO.util.Dom.hasClass(elements[0], TUI_HIDDEN_CLASS)) {
+        _TUI_store(aClass, 0);
+    }
+    else {
+        _TUI_store(aClass, 1);
     }
-  }
+}
 
-  // TUI_change: Function to process class. 
-  // Usualy called from onclick event of button
+function _TUI_store(aClass, state) {
+    YAHOO.util.Cookie.setSub(TUI_COOKIE_NAME, aClass, state,
+    {
+        expires: new Date('January 1, 2038'),
+        path: BUGZILLA.param.cookie_path
+    });
+}
 
-  function TUI_change(cookiesuffix, clsname, action) {
-    if (TUICookiesEnabled > 0) {
-      var els, i;
-      els = document.getElementsByTagName('*');
-      for (i=0; i<els.length; i++) {
-        if (els[i].className.match(clsname)) {
-          TUI_apply(els[i], action);
+function _TUI_restore() {
+    var classes = YAHOO.util.Cookie.getSubs(TUI_COOKIE_NAME);
+    for (item in classes) {
+        if (classes[item] == 0) {
+            var elements = YAHOO.util.Dom.getElementsByClassName(item);
+            for (var i = 0; i < elements.length; i++) {
+                YAHOO.util.Dom.addClass(elements[i], 'bz_tui_hidden');
+            }
+            _TUI_toggle_control_link(item);
         }
-      }
-      TUIClasses[clsname]=action;
-      TUI_setCookie(cookiesuffix);
     }
-  }
-  
-  // TUI_setCookie: Function to set TUI cookie. 
-  // Used internally
+}
 
-  function TUI_setCookie(cookiesuffix) {
-    var cookieval = "";
-    var expireOn = new Date();
-    expireOn.setYear(expireOn.getFullYear() + 25); 
-    for (clsname in TUIClasses) {
-      if (cookieval.length > 0)
-        cookieval += ",";
-      cookieval += clsname+":"+TUIClasses[clsname];
-    }
-    document.cookie="Bugzilla_TUI_"+cookiesuffix+"="+cookieval+"; expires="+expireOn.toString();
-  }
-
-  // TUI_getCookie: Function to get TUI cookie. 
-  // Used internally
-
-  function TUI_getCookie(cookiesuffix) {
-    var dc = document.cookie;
-    var begin, end;
-    var cookiePrefix = "Bugzilla_TUI_"+cookiesuffix+"="; 
-    begin = dc.indexOf(cookiePrefix, end);
-    if (begin != -1) {
-      begin += cookiePrefix.length;
-      end = dc.indexOf(";", begin);
-      if (end == -1) {
-        end = dc.length;
-      }
-      return unescape(dc.substring(begin, end));
-    }
-    return "";
-  }
+YAHOO.util.Event.onDOMReady(_TUI_restore);

js/util.js

@@ -253,3 +253,21 @@ function bz_fireEvent(anElement, anEvent) {
     evt.initEvent(anEvent, true, true); // event type, bubbling, cancelable
     return !anElement.dispatchEvent(evt);
 }
+
+/**
+ * Adds a CSS class to an element if it doesn't have it. Removes the
+ * CSS class from the element if the element does have the class.
+ *
+ * Requires YUI's Dom library.
+ *
+ * @param anElement  The element to toggle the class on
+ * @param aClass     The name of the CSS class to toggle.
+ */
+function bz_toggleClass(anElement, aClass) {
+    if (YAHOO.util.Dom.hasClass(anElement, aClass)) {
+        YAHOO.util.Dom.removeClass(anElement, aClass);
+    }
+    else {
+        YAHOO.util.Dom.addClass(anElement, aClass);
+    }
+}

js/yui/cookie.js

+/*
+Copyright (c) 2008, Yahoo! Inc. All rights reserved.
+Code licensed under the BSD License:
+http://developer.yahoo.net/yui/license.txt
+version: 2.6.0
+*/
+YAHOO.namespace("util");YAHOO.util.Cookie={_createCookieString:function(B,D,C,A){var F=YAHOO.lang;var E=encodeURIComponent(B)+"="+(C?encodeURIComponent(D):D);if(F.isObject(A)){if(A.expires instanceof Date){E+="; expires="+A.expires.toGMTString();}if(F.isString(A.path)&&A.path!=""){E+="; path="+A.path;}if(F.isString(A.domain)&&A.domain!=""){E+="; domain="+A.domain;}if(A.secure===true){E+="; secure";}}return E;},_createCookieHashString:function(B){var D=YAHOO.lang;if(!D.isObject(B)){throw new TypeError("Cookie._createCookieHashString(): Argument must be an object.");}var C=new Array();for(var A in B){if(D.hasOwnProperty(B,A)&&!D.isFunction(B[A])&&!D.isUndefined(B[A])){C.push(encodeURIComponent(A)+"="+encodeURIComponent(String(B[A])));}}return C.join("&");},_parseCookieHash:function(E){var D=E.split("&"),F=null,C=new Object();if(E.length>0){for(var B=0,A=D.length;B<A;B++){F=D[B].split("=");C[decodeURIComponent(F[0])]=decodeURIComponent(F[1]);}}return C;},_parseCookieString:function(I,A){var J=new Object();if(YAHOO.lang.isString(I)&&I.length>0){var B=(A===false?function(K){return K;}:decodeURIComponent);if(/[^=]+=[^=;]?(?:; [^=]+=[^=]?)?/.test(I)){var G=I.split(/;\s/g);var H=null;var C=null;var E=null;for(var D=0,F=G.length;D<F;D++){E=G[D].match(/([^=]+)=/i);if(E instanceof Array){H=decodeURIComponent(E[1]);C=B(G[D].substring(E[1].length+1));}else{H=decodeURIComponent(G[D]);C=H;}J[H]=C;}}}return J;},get:function(A,B){var D=YAHOO.lang;var C=this._parseCookieString(document.cookie);if(!D.isString(A)||A===""){throw new TypeError("Cookie.get(): Cookie name must be a non-empty string.");}if(D.isUndefined(C[A])){return null;}if(!D.isFunction(B)){return C[A];}else{return B(C[A]);}},getSub:function(A,C,B){var E=YAHOO.lang;var D=this.getSubs(A);if(D!==null){if(!E.isString(C)||C===""){throw new TypeError("Cookie.getSub(): Subcookie name must be a non-empty string.");}if(E.isUndefined(D[C])){return null;}if(!E.isFunction(B)){return D[C];}else{return B(D[C]);}}else{return null;}},getSubs:function(A){if(!YAHOO.lang.isString(A)||A===""){throw new TypeError("Cookie.getSubs(): Cookie name must be a non-empty string.");}var B=this._parseCookieString(document.cookie,false);if(YAHOO.lang.isString(B[A])){return this._parseCookieHash(B[A]);}return null;},remove:function(B,A){if(!YAHOO.lang.isString(B)||B===""){throw new TypeError("Cookie.remove(): Cookie name must be a non-empty string.");}A=A||{};A.expires=new Date(0);return this.set(B,"",A);},removeSub:function(B,D,A){if(!YAHOO.lang.isString(B)||B===""){throw new TypeError("Cookie.removeSub(): Cookie name must be a non-empty string.");}if(!YAHOO.lang.isString(D)||D===""){throw new TypeError("Cookie.removeSub(): Subcookie name must be a non-empty string.");}var C=this.getSubs(B);if(YAHOO.lang.isObject(C)&&YAHOO.lang.hasOwnProperty(C,D)){delete C[D];return this.setSubs(B,C,A);}else{return"";}},set:function(B,C,A){var E=YAHOO.lang;if(!E.isString(B)){throw new TypeError("Cookie.set(): Cookie name must be a string.");}if(E.isUndefined(C)){throw new TypeError("Cookie.set(): Value cannot be undefined.");}var D=this._createCookieString(B,C,true,A);document.cookie=D;return D;},setSub:function(B,D,C,A){var F=YAHOO.lang;if(!F.isString(B)||B===""){throw new TypeError("Cookie.setSub(): Cookie name must be a non-empty string.");}if(!F.isString(D)||D===""){throw new TypeError("Cookie.setSub(): Subcookie name must be a non-empty string.");}if(F.isUndefined(C)){throw new TypeError("Cookie.setSub(): Subcookie value cannot be undefined.");}var E=this.getSubs(B);if(!F.isObject(E)){E=new Object();}E[D]=C;return this.setSubs(B,E,A);},setSubs:function(B,C,A){var E=YAHOO.lang;if(!E.isString(B)){throw new TypeError("Cookie.setSubs(): Cookie name must be a string.");}if(!E.isObject(C)){throw new TypeError("Cookie.setSubs(): Cookie value must be an object.");}var D=this._createCookieString(B,this._createCookieHashString(C),false,A);document.cookie=D;return D;}};YAHOO.register("cookie",YAHOO.util.Cookie,{version:"2.6.0",build:"1321"});
\ No newline at end of file

skins/standard/global.css

@@ -215,6 +215,11 @@
     }
 /* generic (end) */
 
+/* Links that control whether or not something is visible. */
+a.controller {
+    font-size: 115%;
+}
+
 div#docslinks {
     float: right;
     border: 1px solid black;
@@ -306,7 +311,7 @@ div#docslinks {
 
 /** End Comments **/
 
-.bz_default_hidden {
+.bz_default_hidden, .bz_tui_hidden {
     display: none;
 }
 

template/en/default/attachment/createformcontents.html.tmpl

@@ -33,7 +33,7 @@
   </td>
 </tr>
 [% IF Param("maxlocalattachment") %]
-<tr>
+<tr class="expert_fields">
   <th>BigFile:</th>
   <td>
     <input type="checkbox" id="bigfile"
@@ -45,7 +45,7 @@
 </tr>
 [% END %]
 [% IF Param("allow_attach_url") %]
-<tr>
+<tr class="expert_fields">
   <th><label for="attachurl">AttachURL</label>:</th>
   <td>
     <em>URL to be attached instead.</em><br>
@@ -54,6 +54,7 @@
            onkeyup="URLFieldHandler()" onblur="URLFieldHandler()">
   </td>
 </tr>
+</tbody>
 [% END %]
 <tr>
   <th><label for="description">Description</label>:</th>
@@ -62,7 +63,7 @@
     <input type="text" id="description" name="description" size="60" maxlength="200">
   </td>
 </tr>
-<tr>
+<tr class="expert_fields">
   <th>Content Type:</th>
   <td>
     <em>If the attachment is a patch, check the box below.</em><br>
@@ -89,7 +90,7 @@
              onchange="if (this.value) this.form.contenttypemethod[2].checked = true;">
   </td>
 </tr>
-<tr>
+<tr class="expert_fields">
   <td> </td>
   <td>
     [% IF flag_types && flag_types.size > 0 %]

template/en/default/bug/create/create.html.tmpl

@@ -34,7 +34,7 @@
                  'skins/standard/yui/calendar.css' ]
   javascript_urls = [ "js/attachment.js", "js/util.js",
                       "js/yui/yahoo-dom-event.js", "js/yui/calendar.js",
-                      "js/field.js" ]
+                      "js/field.js", "js/yui/cookie.js", "js/TUI.js" ]
 %]
 
 <script type="text/javascript">
@@ -159,6 +159,12 @@ function handleWantsAttachment(wants_attachment) {
     }
 }
 
+
+TUI_alternates['expert_fields'] = 'Show Advanced Fields';
+// Hide the Advanced Fields by default, unless the user has a cookie
+// that specifies otherwise.
+TUI_hide_default('expert_fields');
+
 -->
 </script>
 
@@ -187,7 +193,16 @@ function handleWantsAttachment(wants_attachment) {
   </tr>
 
   <tr>
-    <td colspan="4">&nbsp;</td>
+    <td colspan="4">
+        <a id="expert_fields_controller" class="controller bz_default_hidden"
+            href="javascript:TUI_toggle_class('expert_fields')">Hide
+        Advanced Fields</a>
+      [%# Show the link if the browser supports JS %]
+      <script type="text/javascript">
+          YAHOO.util.Dom.removeClass('expert_fields_controller', 
+                                     'bz_default_hidden');
+      </script>
+    </td>
   </tr>
 
   <tr>
@@ -454,7 +469,7 @@ function handleWantsAttachment(wants_attachment) {
   </tr>
 </tbody>
 
-<tbody>
+<tbody class="expert_fields">
   [% USE Bugzilla %]
 
   [% FOREACH field = Bugzilla.active_custom_fields %]
@@ -466,6 +481,9 @@ function handleWantsAttachment(wants_attachment) {
         value_span = 3 %]
     </tr>
   [% END %]
+</tbody>
+
+<tbody>
 
   <tr>
     <th>Summary:</th>
@@ -501,7 +519,7 @@ function handleWantsAttachment(wants_attachment) {
   </tr>
 
   [% IF Param("insidergroup") && user.in_group(Param("insidergroup")) %]
-    <tr>
+    <tr class="expert_fields">
       <th>&nbsp;</th>
       <td colspan="3">
         &nbsp;&nbsp;
@@ -513,9 +531,7 @@ function handleWantsAttachment(wants_attachment) {
       </td>
     </tr>
   [% END %]
-</tbody>
 
-<tbody class="expert_fields">
   <tr>
     <th>Attachment:</th>
     <td colspan="3">
@@ -550,7 +566,9 @@ function handleWantsAttachment(wants_attachment) {
       </script>
     </td>
   </tr>
+</tbody>
 
+<tbody class="expert_fields">
   [% IF user.in_group('editbugs', product.id) %]
     [% IF use_keywords %]
       <tr>
@@ -577,7 +595,7 @@ function handleWantsAttachment(wants_attachment) {
   [% END %]
 </tbody>
 
-<tbody>
+<tbody class="expert_fields">
   [% IF group.size %]
   <tr>
     <th>&nbsp;</th>
@@ -604,7 +622,9 @@ function handleWantsAttachment(wants_attachment) {
     </td>
   </tr>
   [% END %]
+</tbody>
 
+<tbody>
   [%# Form controls for entering additional data about the bug being created. %]
   [% Hook.process("form") %]
 

template/en/default/global/header.html.tmpl

@@ -188,12 +188,23 @@
             type="text/css">
     <![endif]-->
 
-
-    [% IF javascript %]
-      <script type="text/javascript">
-        [% javascript %]
-      </script>
-    [% END %]
+    <script type="text/javascript">
+    <!--
+        [%# Make some Bugzilla information available to all scripts. 
+          # We don't import every parameter and constant because we
+          # don't want to add a lot of uncached JS to every page. 
+          #%]
+        var BUGZILLA = {
+            param: {
+                cookiepath: '[% Param('cookiepath') FILTER js %]'
+            }
+        };
+
+        [% IF javascript %]
+          [% javascript %]
+        [% END %]
+    // -->
+    </script>
 
     [% IF javascript_urls %]
       [% FOREACH javascript_url = javascript_urls %]