Bug 277377: Classifications should support sort keys - Patch by Olav Vitters…

Bugzilla/Classification.pm

@@ -31,6 +31,7 @@ use constant DB_COLUMNS => qw(
     classifications.id
     classifications.name
     classifications.description
+    classifications.sortkey
 );
 
 our $columns = join(", ", DB_COLUMNS);
@@ -122,6 +123,7 @@ sub products {
 sub id          { return $_[0]->{'id'};          }
 sub name        { return $_[0]->{'name'};        }
 sub description { return $_[0]->{'description'}; }
+sub sortkey     { return $_[0]->{'sortkey'};     }
 
 ###############################
 ####      Subroutines      ####
@@ -131,7 +133,7 @@ sub get_all_classifications {
     my $dbh = Bugzilla->dbh;
 
     my $ids = $dbh->selectcol_arrayref(q{
-        SELECT id FROM classifications ORDER BY name});
+        SELECT id FROM classifications ORDER BY sortkey, name});
 
     my @classifications;
     foreach my $id (@$ids) {

Bugzilla/DB/Schema.pm

@@ -854,6 +854,7 @@ use constant ABSTRACT_SCHEMA => {
                             PRIMARYKEY => 1},
             name        => {TYPE => 'varchar(64)', NOTNULL => 1},
             description => {TYPE => 'MEDIUMTEXT'},
+            sortkey     => {TYPE => 'INT2', NOTNULL => 1, DEFAULT => '0'},
         ],
         INDEXES => [
             classifications_name_idx => {FIELDS => ['name'],

Bugzilla/User.pm

@@ -557,7 +557,8 @@ sub get_selectable_classifications {
         $class->{$product->classification_id} ||= 
             new Bugzilla::Classification($product->classification_id);
     }
-    my @sorted_class = sort {lc($a->name) cmp lc($b->name)} (values %$class);
+    my @sorted_class = sort {$a->sortkey <=> $b->sortkey 
+                             || lc($a->name) cmp lc($b->name)} (values %$class);
     $self->{selectable_classifications} = \@sorted_class;
     return $self->{selectable_classifications};
 }

checksetup.pl

@@ -4229,6 +4229,25 @@ if ($dbh->bz_column_info("namedqueries", "linkinfooter")) {
     $dbh->bz_drop_column("namedqueries", "linkinfooter");    
 }
 
+# 2006-07-07 olav@bkor.dhs.org - Bug 277377
+# Add a sortkey to the classifications
+if (!$dbh->bz_column_info('classifications', 'sortkey')) {
+    print "Adding sortkey column to classifications table...\n" unless $silent;
+
+    $dbh->bz_add_column('classifications', 'sortkey',
+                        {TYPE => 'INT2', NOTNULL => 1, DEFAULT => 0});
+
+    my $class_ids = $dbh->selectcol_arrayref('SELECT id FROM classifications ' .
+                                             'ORDER BY name');
+    my $sth = $dbh->prepare('UPDATE classifications SET sortkey = ? ' .
+                            'WHERE id = ?');
+    my $sortkey = 0;
+    foreach my $class_id (@$class_ids) {
+        $sth->execute($sortkey, $class_id);
+        $sortkey += 100;
+    }
+}
+
 # If you had to change the --TABLE-- definition in any way, then add your
 # differential change code *** A B O V E *** this comment.
 #

editclassifications.cgi

@@ -108,12 +108,15 @@ if ($action eq 'new') {
     }
     
     my $description = trim($cgi->param('description')  || '');
+    my $sortkey = trim($cgi->param('sortkey') || 0);
+
     trick_taint($description);
     trick_taint($class_name);
+    detaint_natural($sortkey);
 
     # Add the new classification.
-    $dbh->do("INSERT INTO classifications (name, description)
-              VALUES (?, ?)", undef, ($class_name, $description));
+    $dbh->do("INSERT INTO classifications (name, description, sortkey)
+              VALUES (?, ?, ?)", undef, ($class_name, $description, $sortkey));
 
     $vars->{'classification'} = $class_name;
 
@@ -201,6 +204,7 @@ if ($action eq 'update') {
 
     my $class_old_name = trim($cgi->param('classificationold') || '');
     my $description    = trim($cgi->param('description')       || '');
+    my $sortkey        = trim($cgi->param('sortkey')           || 0);
 
     my $class_old =
         Bugzilla::Classification::check_classification($class_old_name);
@@ -230,6 +234,15 @@ if ($action eq 'update') {
         $vars->{'updated_description'} = 1;
     }
 
+    if ($sortkey ne $class_old->sortkey) {
+        detaint_natural($sortkey);
+        $dbh->do("UPDATE classifications SET sortkey = ?
+                  WHERE id = ?", undef,
+                 ($sortkey, $class_old->id));
+
+        $vars->{'updated_sortkey'} = 1;
+    }
+
     $dbh->bz_unlock_tables();
 
     LoadTemplate($action);

enter_bug.cgi

@@ -79,7 +79,9 @@ if ($product_name eq '') {
             $class->{$product->classification_id} ||=
                 new Bugzilla::Classification($product->classification_id);
         }
-        my @classifications = sort {lc($a->name) cmp lc($b->name)} (values %$class);
+        my @classifications = sort {$a->sortkey <=> $b->sortkey
+                                    || lc($a->name) cmp lc($b->name)}
+                                   (values %$class);
 
         # We know there is at least one classification available,
         # else we would have stopped earlier.

template/en/default/admin/classifications/add.html.tmpl

@@ -40,6 +40,11 @@
         %]
       </td>
     </tr>
+    <tr>
+      <th align="right"><label for="sortkey">Sortkey:</label></th>
+      <td><input id="sortkey" size="20" maxlength="20" name="sortkey" 
+                 value=""></td>
+    </tr>
   </table>
   <hr>
   <input type=submit value="Add">

template/en/default/admin/classifications/del.html.tmpl

@@ -42,6 +42,10 @@
     [% END %]
   </td>
 
+</tr><tr>
+  <td valign="top">Sortkey:</td>
+  <td valign="top">[% classification.sortkey FILTER html %]</td>
+
 </tr>
 </table>
 

template/en/default/admin/classifications/edit.html.tmpl

@@ -41,6 +41,11 @@
         %]
       </td>
     </tr>
+    <tr>
+      <th align="right"><label for="sortkey">Sortkey:</label></th>
+      <td><input id="sortkey" size="20" maxlength="20" name="sortkey" value="
+      [%- classification.sortkey FILTER html %]"></td>
+    </tr>
     <tr valign=top>
       <th align="right">
         <a href="editproducts.cgi?classification=[% classification.name FILTER url_quote %]">

template/en/default/admin/classifications/reclassify.html.tmpl

@@ -40,6 +40,10 @@
       </td>
 
     </tr><tr>
+      <td valign="top">Sortkey:</td>
+      <td valign="top" colspan=3>[% classification.sortkey FILTER html %]</td>
+
+    </tr><tr>
       <td valign="top">Products:</td>
       <td valign="top">Products</td>
       <td></td>

template/en/default/admin/classifications/select.html.tmpl

@@ -27,6 +27,7 @@
   <tr bgcolor="#6666ff">
     <th align="left">Edit Classification ...</th>
     <th align="left">Description</th>
+    <th align="left">Sortkey</th>
     <th align="left">Products</th>
     <th align="left">Action</th>
   </tr>
@@ -41,6 +42,7 @@
         <font color="red">none</font>
       [% END %]
       </td>
+      <td valign="top">[% cl.sortkey FILTER html %]</td>
       [% IF (cl.id == 1) %]
         <td valign="top">[% cl.product_count FILTER html %]</td>
       [% ELSE %]
@@ -57,7 +59,7 @@
   [% END %]
 
   <tr>
-    <td valign="top" colspan=3>Add a new classification</td>
+    <td valign="top" colspan=4>Add a new classification</td>
     <td valign="top" align="center"><a href="editclassifications.cgi?action=add">Add</a></td>
   </tr>
 </table>

template/en/default/admin/classifications/update.html.tmpl

@@ -23,6 +23,10 @@
   title = "Update classification"
 %]
 
+[% IF updated_sortkey %] 
+  Updated sortkey.<br>
+[% END %]
+
 [% IF updated_description %] 
   Updated description.<br>
 [% END %]