Changeset 33476 for main/trunk/greenstone2/perllib/sorttools.pm

Timestamp:

2019-09-16T12:30:00+12:00 (5 years ago)

Author:

kjdon

Message:

enabled having customsorttools in collection's perllib folder. you can implement any of sorttools functions to customise the formatting for the collection's sort.

File:

• main/trunk/greenstone2/perllib/sorttools.pm (modified) (7 diffs)

main/trunk/greenstone2/perllib/sorttools.pm

@@ -27 +27 @@
 # for sorting
 
+# To customise sort functions for a particular collection, create a customsorttools.pm inside
+# collection's perllib folder, and implement any of the functions you want to change.
+
 package sorttools;
 
 use strict;
+
+my $has_custom_sort = 0;
+
+sub setup_custom_sort {
+
+    my $collectdir = $ENV{'GSDLCOLLECTDIR'};
+    my $customperllibfolder = &FileUtils::filenameConcatenate($collectdir,  'perllib');
+    my $customsortfile = &FileUtils::filenameConcatenate($customperllibfolder, 'customsorttools.pm');
+    if (&FileUtils::fileExists($customsortfile)) {
+    # add perllib folder to INC, if its not already there
+    my $found_perllibfolder = 0;
+    foreach my $path (@INC)
+    {
+        if ($path eq $customperllibfolder)
+        {
+        $found_perllibfolder = 1;
+        last;
+        }
+    }
+    if (!$found_perllibfolder)
+    {
+        unshift (@INC, $customperllibfolder);
+    }
+    
+    require customsorttools;
+    $has_custom_sort = 1;
+    }
+
+}
 
 # moved here from BasClas so import can share it
 sub format_metadata_for_sorting {
     my ($metaname, $metavalue, $doc_obj) = @_;
+
+    if ($has_custom_sort && defined (&customsorttools::format_metadata_for_sorting)) {
+    return &customsorttools::format_metadata_for_sorting($metaname, $metavalue, $doc_obj);
+    }
+    
     if (!defined $metaname || $metaname !~ /\S/ || ! defined $metavalue || $metavalue !~ /\S/) {
     return "";
@@ -51 +88 @@
     # is this metadata likely to be a name?
     my $function_name="format_string_name_$lang";
-    if ($metaname =~ /^(?:\w+\.)?(?:Creators?|Authors?|Editors?)(?:[:,].*)?$/
+    if ($metaname =~ /^(?:\w+\.)?(?:Creators?|Authors?|Editors?)(?:[:,].*)?$/ 
     && exists &$function_name) {
     no strict 'refs';
     &$function_name(\$metavalue);
     } else {
-    $function_name="format_string_$lang";
+    $function_name="format_string_$lang";   
     if (exists &$function_name) {
         no strict 'refs';
@@ -75 +112 @@
 sub format_string_en {
     my $stringref = shift;
+
+    if ($has_custom_sort && defined (&customsorttools::format_string_en)) {
+    return &customsorttools::format_string_en($stringref);
+    }
+    
     $$stringref = lc($$stringref);
     $$stringref =~ s/&[^\;]+\;//g; # html entities
@@ -86 +128 @@
 sub format_string_name_en {
     my ($stringref) = @_;
+
+    if ($has_custom_sort && defined (&customsorttools::format_string_name_en)) {
+    return &customsorttools::format_string_name_en($stringref);
+    }
+    
     $$stringref =~ tr/A-Z/a-z/;
     $$stringref =~ s/&\S+;//g;
@@ -112 +159 @@
     my $stringref = shift;
 
+    if ($has_custom_sort && defined (&customsorttools::format_string_fr)) {
+    return &customsorttools::format_string_fr($stringref);
+    }
+
     $$stringref = lc($$stringref);
     $$stringref =~ s/&[^\;]+\;//g; # html entities
@@ -123 +174 @@
 sub format_string_es {
     my $stringref = shift;
+
+    if ($has_custom_sort && defined (&customsorttools::format_string_es)) {
+    return &customsorttools::format_string_es($stringref);
+    }
 
     $$stringref = lc($$stringref);
@@ -142 +197 @@
     my ($day, $month, $year) = @_;
 
+    if ($has_custom_sort && defined (&customsorttools::format_date)) {
+    return &customsorttools::format_date($day, $month, $year);
+    }
+    
     my %months = ('january' => '01', 'jan' => '01', 'february' => '02', 'feb' => '02',
           'march' => '03', 'mar' => '03', 'april' => '04', 'apr' => '04',