Tweaks to code that generates links in ViewCVS pages. The only

externally visible difference is that in root_as_url mode,
links with "root" parameters no longer get a redundant path
component pointing at the current root.

* lib/viewcvs.py
  (_sticky_vars):
    don't make root a sticky var, it gets special treatment anyway
    and having it sticky just makes things more complicated

  (Request.get_link):
    remove redundant and never-used rootname argument

    make logic that suppresses sticky variables on checkout and
    tarball links more explicit

    change code for merging sticky variables to operate on the
    dictionary of parameters instead of building a new dictionary

    make code that handles the "root" parameter generate minimal
    URLs in all circumstances

  (Request.get_options):
    removed, logic moved into Request.get_link

  (Request.sticky_vars):
    new method that returns a dictionary of stick variables

  (view_annotate, view_cvsgraph):
    call Request.sticky_vars instead of Request.get_options


git-svn-id: http://viewvc.tigris.org/svn/viewvc/trunk@926 8cb11bc2-c004-0410-86c3-e597b4017df7

lib/viewcvs.py

@@ -83,7 +83,6 @@ alt_mime_type = 'text/x-cvsweb-markup'
 # put here the variables we need in order to hold our state - they will be
 # added (with their current value) to any link/query string you construct
 _sticky_vars = (
-  'root',
   'hideattic',
   'sortby',
   'sortdir',
@@ -366,8 +365,8 @@ class Request:
        result = self.server.escape(result)
     return result
 
-  def get_link(self, view_func = None, rootname = None, where = None,
+  def get_link(self, view_func = None, where = None, pathtype = None,
-    params = None, pathtype = None):
+               params = None):
     """Constructs a link pointing to another ViewCVS page. All arguments
     correspond to members of the Request object. If they are set to 
     None they take values from the current page. Return value is a base
@@ -376,9 +375,6 @@ class Request:
     if view_func is None:
       view_func = self.view_func
 
-    if rootname is None:
-      rootname = self.rootname
-
     if params is None:
       params = self.query_dict.copy()
 
@@ -393,7 +389,8 @@ class Request:
       where = self.where
       pathtype = self.pathtype
 
-    last_link = view_func is view_checkout or view_func is download_tarball
+    # tack on sticky variables by default
+    sticky_vars = 1
 
     # The logic used to construct the URL is an inverse of the
     # logic used to interpret URLs in Request.run_viewcvs
@@ -405,14 +402,27 @@ class Request:
       url = url + '/' + checkout_magic_path
       view_func = None
 
-    # add root name
+    # add root to url
     if cfg.options.root_as_url_component:
-      url = url + '/' + rootname
+      # remove root from parameter list if present
-    elif not (params.has_key('root') and params['root'] is None):
+      try:
-      if rootname != cfg.general.default_root:
+        rootname = params['root']
-        params['root'] = rootname
+      except KeyError:
+        rootname = self.rootname
       else:
-        params['root'] = None
+        del params['root']
+
+      # add root path component
+      if rootname is not None:
+        url = url + '/' + rootname
+
+    else:
+      # add root to parameter list
+      rootname = params.setdefault('root', self.rootname)
+      
+      # no need to specify default root
+      if rootname == cfg.general.default_root:
+        del params['root']   
 
     # add path
     if where and where != '':
@@ -422,10 +432,15 @@ class Request:
     if view_func is download_tarball:
       if not where: url = url + '/root'
       url = url + '.tar.gz'
+
+      # no need to add sticky variables, download_tarball won't use them ...
+      sticky_vars = 0
+
+      # ... except for "only_with_tag" which we add manually
       if not params.has_key('only_with_tag'):
         params['only_with_tag'] = self.query_dict.get('only_with_tag')
 
-    # add trailing slash for a directory      
+    # add trailing slash for a directory
     elif pathtype == vclib.DIR:
       url = url + '/'
 
@@ -456,6 +471,10 @@ class Request:
       and params.has_key('r2'):
       view_func = None
 
+    # no need to add sticky variables for checkout view
+    if view_func is view_checkout:
+      sticky_vars = 0
+
     # no need to explicitly specify checkout view when
     # there's a rev parameter
     if view_func is view_checkout and params.has_key('rev'):
@@ -465,19 +484,27 @@ class Request:
     if view_code and not (params.has_key('view') and params['view'] is None):
       params['view'] = view_code
 
-    return url, self.get_options(params, not last_link)
+    # add sticky values to parameter list
-
-  def get_options(self, params = {}, sticky_vars=1):
-    """Combine params with current sticky values"""
-    ret = { }
     if sticky_vars:
       for name in _sticky_vars:
         value = self.query_dict.get(name)
-        if value is not None and not params.has_key(name):
+        if value is not None:
-          ret[name] = self.query_dict[name]
+          params.setdefault(name, value)
-    for name, val in params.items():
+
-      if val is not None:
+    # remove null values from parameter list
-        ret[name] = val
+    for name, value in params.items():
+      if value is None:
+        del params[name]
+
+    return url, params
+
+  def sticky_vars(self):
+    """Return a dictionary of sticky variables"""
+    ret = { }
+    for name in _sticky_vars:
+      value = self.query_dict.get(name)
+      if value is not None:
+        ret[name] = value
     return ret
 
   def setup_mime_type_info(self):
@@ -1953,7 +1980,7 @@ def view_annotate(request):
   rcsfile = request.repos.rcsfile(request.path_parts)
   data['lines'] = blame.BlameSource(request.repos.rootpath,
                                     rcsfile, rev,
-                                    request.server.escape(compat.urlencode(request.get_options())))
+                                    request.server.escape(compat.urlencode(request.sticky_vars())))
 
   request.server.header()
   generate_page(request, cfg.templates.annotate, data)
@@ -1988,7 +2015,7 @@ def view_cvsgraph(request):
   # Uncomment and set accordingly if required.
   #os.environ['LD_LIBRARY_PATH'] = '/usr/lib:/usr/local/lib'
 
-  query = compat.urlencode(request.get_options({}))
+  query = compat.urlencode(request.sticky_vars())
   amp_query = query and '&' + query
   qmark_query = query and '?' + query