Koha/Manual.pm

   1 package Koha::Manual;
   2
   3 use Modern::Perl;
   4
   5 use C4::Context;
   6
   7 sub _get_help_version {
   8     my $help_version = C4::Context->preference("Version");
   9     if ( $help_version =~ m|^(\d+)\.(\d{2}).*$| ) {
  10         my $version = $1;
  11         my $major = $2;
  12         unless ( $major % 2 ) { $major-- };
  13         $major = sprintf("%02d", $major);
  14         $help_version = "$version.$major";
  15     }
  16     return $help_version;
  17 }
  18
  19 sub _get_base_url {
  20     my ( $preferred_language ) = @_;
  21
  22     my @available_languages = qw( en ar cs es fr it pt_BR tz zh_TW );
  23
  24     my ( $language ) = grep {
  25         my $preferred_short = substr $preferred_language, 0, 2;
  26         my $avail_short = substr $_, 0, 2;
  27         $preferred_short eq $avail_short ? $_ : ()
  28     } @available_languages;
  29
  30     my $KohaManualLanguage = $language || C4::Context->preference('KohaManualLanguage') || 'en';
  31     my $KohaManualBaseURL = C4::Context->preference('KohaManualBaseURL') || 'https://koha-community.org/manual';
  32     if ( $KohaManualBaseURL =~ m|^/| ) {
  33         $KohaManualBaseURL = C4::Context->preference('staffClientBaseURL') . $KohaManualBaseURL;
  34     }
  35     return $KohaManualBaseURL . '/' . _get_help_version . '/' . $KohaManualLanguage . '/html'; # TODO html could be a KohaManualFormat with pdf, html, epub
  36 }
  37
  38 our $mapping = {
  39     'about'                                    => '/plugins.html#about-koha',
  40     'acqui/acqui-home'                         => '/acquisitions.html',
  41     'acqui/addorderiso2709'                    => '/acquisitions.html#create-a-basket',
  42     'acqui/basket'                             => '/acquisitions.html#create-a-basket',
  43     'acqui/basketgroup'                        => '/acquisitions.html#create-a-basket-group',
  44     'acqui/basketheader'                       => '/acquisitions.html#create-a-basket',
  45     'acqui/booksellers'                        => '/acquisitions.html#acquisition-searches',
  46     'acqui/edifactmsgs'                        => '/acquisitions.html#edifact-messages',
  47     'acqui/histsearch'                         => '/acquisitions.html#acquisition-searches',
  48     'acqui/invoice'                            => '/acquisitions.html#invoices',
  49     'acqui/invoices'                           => '/acquisitions.html#invoices',
  50     'acqui/lateorders'                         => '/acquisitions.html#claims-late-orders',
  51     'acqui/neworderbiblio'                     => '/acquisitions.html#create-a-basket',
  52     'acqui/neworderempty'                      => '/acquisitions.html#create-a-basket',
  53     'acqui/newordersubscription'               => '/acquisitions.html#create-a-basket',
  54     'acqui/newordersuggestion'                 => '/acquisitions.html#create-a-basket',
  55     'acqui/orderreceive'                       => '/acquisitions.html#receiving-orders',
  56     'acqui/parcel'                             => '/acquisitions.html#receiving-orders',
  57     'acqui/parcels'                            => '/acquisitions.html#receiving-orders',
  58     'acqui/supplier'                           => '/acquisitions.html#vendors',
  59     'acqui/uncertainprice'                     => '/acquisitions.html#create-a-basket',
  60     'acqui/z3950_search'                       => '/acquisitions.html#create-a-basket',
  61     'admin/admin-home'                         => '/administration.html',
  62     'admin/aqbudgetperiods'                    => '/administration.html#budgets',
  63     'admin/aqbudgets'                          => '/administration.html#funds',
  64     'admin/aqcontract'                         => '/acquisitions.html#vendor-contracts',
  65     'admin/aqplan'                             => '/administration.html#budget-planning',
  66     'admin/auth_subfields_structure'           => '/administration.html#authority-types',
  67     'admin/auth_tag_structure'                 => '/administration.html#authority-types',
  68     'admin/authorised_values'                  => '/administration.html#authorized-values',
  69     'admin/authtypes'                          => '/administration.html#authority-types',
  70     'admin/biblio_framework'                   => '/administration.html#marc-bibliographic-frameworks',
  71     'admin/branch_transfer_limits'             => '/administration.html#library-transfer-limits',
  72     'admin/branches'                           => '/administration.html#libraries-&-groups',
  73     'admin/categories'                         => '/administration.html#patron-categories',
  74     'admin/checkmarc'                          => '/administration.html#marc-bibliographic-framework-test',
  75     'admin/cities'                             => '/administration.html#cities-and-towns',
  76     'admin/classsources'                       => '/administration.html#classification-sources',
  77     'admin/columns_settings'                   => '/administration.html#column-settings',
  78     'admin/currency'                           => '/administration.html#currencies-and-exchange-rates',
  79     'admin/didyoumean'                         => '/administration.html#did-you-mean?',
  80     'admin/edi_accounts'                       => '/administration.html#edi-accounts',
  81     'admin/edi_ean_accounts'                   => '/administration.html#library-eans',
  82     'admin/item_circulation_alerts'            => '/administration.html#item-circulation-alerts',
  83     'admin/items_search_fields'                => '/administration.html#item-search-fields',
  84     'admin/itemtypes'                          => '/administration.html#item-types',
  85     'admin/koha2marclinks'                     => '/administration.html#koha-to-marc-mapping',
  86     'admin/marc_subfields_structure'           => '/administration.html#marc-bibliographic-frameworks',
  87     'admin/marctagstructure'                   => '/administration.html#marc-bibliographic-frameworks',
  88     'admin/matching-rules'                     => '/administration.html#record-matching-rules',
  89     'admin/oai_set_mappings'                   => '/administration.html#oai-sets-configuration',
  90     'admin/oai_sets'                           => '/administration.html#oai-sets-configuration',
  91     'admin/patron-attr-types'                  => '/administration.html#patron-attribute-types',
  92     'admin/preferences'                        => '/globalpreferences.html',
  93     'admin/preferences#accounting'             => '/accountspreferences.html',
  94     'admin/preferences#acquisitions'           => '/acquisitionspreferences.html',
  95     'admin/preferences#admin'                  => '/administrationpreferences.html',
  96     'admin/preferences#authorities'            => '/authoritiespreferences.html',
  97     'admin/preferences#cataloguing'            => '/catalogingpreferences.html',
  98     'admin/preferences#circulation'            => '/circulationpreferences.html',
  99     'admin/preferences#enhanced_content'       => '/enhancedcontentpreferences.html',
 100     'admin/preferences#i18n_l10n'              => '/i18npreferences.html',
 101     'admin/preferences#logs'                   => '/logspreferences.html',
 102     'admin/preferences#opac'                   => '/opacpreferences.html',
 103     'admin/preferences#patrons'                => '/patronspreferences.html',
 104     'admin/preferences#searching'              => '/searchingpreferences.html',
 105     'admin/preferences#serials'                => '/serialspreferences.html',
 106     'admin/preferences#staff_interface'        => '/staffclientpreferences.html',
 107     'admin/preferences#staff_interface'        => '/staffclientpreferences.html',
 108     'admin/preferences#tools'                  => '/toolspreferences.html',
 109     'admin/preferences#web_services'           => '/webservicespreferences.html',
 110     'admin/smart-rules'                        => '/administration.html#circulation-and-fine-rules',
 111     'admin/sms_providers'                      => '/administration.html#sms-cellular-providers',
 112     'admin/systempreferences'                  => '/localusepreferences.html',
 113     'admin/transport-cost-matrix'              => '/administration.html#transport-cost-matrix',
 114     'admin/z3950servers'                       => '/administration.html#z39.50/sru-servers',
 115     'authorities/authorities-home'             => '/cataloging.html#authorities',
 116     'authorities/authorities'                  => '/cataloging.html#authorities',
 117     'authorities/detail'                       => '/cataloging.html#authorities',
 118     'authorities/merge'                        => '/cataloging.html#merging-authorities',
 119     'catalogue/detail'                         => '/cataloging.html#bibliographic-records',
 120     'catalogue/issuehistory'                   => '/cataloging.html#item-specific-circulation-history',
 121     'catalogue/itemsearch'                     => '/searching.html#item-searching',
 122     'catalogue/moredetail'                     => '/cataloging.html#item-records',
 123     'catalogue/search-history'                 => '/plugins.html#search-history',
 124     'catalogue/search'                         => '/searching.html',
 125     'cataloguing/cataloging-home'              => '/cataloging.html',
 126     'cataloguing/addbiblio'                    => '/cataloging.html#bibliographic-records',
 127     'cataloguing/addbooks'                     => '/cataloging.html',
 128     'cataloguing/additem'                      => '/cataloging.html#item-records',
 129     'cataloguing/cataloging-home.pl'           => '/cataloging.html',
 130     'cataloguing/linkitem'                     => '/cataloging.html#adding-analytic-records',
 131     'cataloguing/merge'                        => '/cataloging.html#merging-records',
 132     'cataloguing/moveitem'                     => '/cataloging.html#moving-items',
 133     'circ/article-requests'                    => '/circulation.html#article-requests',
 134     'circ/branchoverdues'                      => '/circulation.html#overdues-with-fines',
 135     'circ/branchtransfers'                     => '/circulation.html#transfers',
 136     'circ/circulation-home'                    => '/circulation.html',
 137     'circ/circulation'                         => '/circulation.html#check-out-(issuing)',
 138     'circ/offline'                             => '/circulation.html#offline-circulation-in-koha',
 139     'circ/on-site_checkouts'                   => '/circulation.html#pending-on-site-checkouts',
 140     'circ/overdue'                             => '/circulation.html#overdues',
 141     'circ/pendingreserves'                     => '/circulation.html#holds-to-pull',
 142     'circ/renew'                               => '/circulation.html#renewing',
 143     'circ/reserveratios'                       => '/circulation.html#hold-ratios',
 144     'circ/returns'                             => '/circulation.html#check-in-returning',
 145     'circ/set-library'                         => '/circulation.html#set-library',
 146     'circ/transferstoreceive'                  => '/circulation.html#transfers-to-receive',
 147     'circ/view_holdsqueue'                     => '/circulation.html#holds-queue',
 148     'circ/waitingreserves'                     => '/circulation.html#holds-awaiting-pickup',
 149     'course_reserves/add_items'                => '/course_reserves.html',
 150     'course_reserves/course-details'           => '/course_reserves.html',
 151     'course_reserves/course-reserves'          => '/course_reserves.html',
 152     'course_reserves/course'                   => '/course_reserves.html#adding-courses',
 153     'erm/erm'                                  => '/erm.html',
 154     'erm/agreements'                           => '/erm.html#agreements',
 155     'erm/agreements/'                          => '/erm.html#search-and-view-an-agreement-record',
 156     'erm/agreements/add'                       => '/erm.html#create-an-agreement-record',
 157     'erm/agreements/edit/'                     => '/erm.html#create-an-agreement-record',
 158     'erm/licenses'                             => '/erm.html#licenses',
 159     'erm/licenses/'                            => '/erm.html#search-and-view-a-license-record',
 160     'erm/licenses/add'                         => '/erm.html#create-a-license-record',
 161     'erm/licenses/edit'                        => '/erm.html#create-a-license-record',
 162     'erm/eholdings/local/packages'             => '/erm.html#local',
 163     'erm/eholdings/local/packages/'            => '/erm.html#local',
 164     'erm/eholdings/local/packages/add'         => '/erm.html#local',
 165     'erm/eholdings/local/packages/edit/'       => '/erm.html#local',
 166     'erm/eholdings/local/titles'               => '/erm.html#titles-1',
 167     'erm/eholdings/local/titles/'              => '/erm.html#titles-1',
 168     'erm/eholdings/local/titles/add'           => '/erm.html#titles-1',
 169     'erm/eholdings/local/titles/edit/'         => '/erm.html#titles-1',
 170     'erm/eholdings/local/titles/import'        => '/erm.html#import-a-new-local-title-record-from-a-list',
 171     'erm/eholdings/local/resources/'           => '/erm.html#eholdings',
 172     'erm/eholdings/ebsco/packages'             => '/erm.html#packages',
 173     'erm/eholdings/ebsco/packages/'            => '/erm.html#packages',
 174     'erm/eholdings/ebsco/packages/add'         => '/erm.html#packages',
 175     'erm/eholdings/ebsco/packages/edit/'       => '/erm.html#packages',
 176     'erm/eholdings/ebsco/titles'               => '/erm.html#titles',
 177     'erm/eholdings/ebsco/titles/'              => '/erm.html#titles',
 178     'erm/eholdings/ebsco/titles/add'           => '/erm.html#titles',
 179     'erm/eholdings/ebsco/titles/edit/'         => '/erm.html#titles',
 180     'erm/eholdings/ebsco/resources/'           => '/erm.html#ebsco',
 181     'ill/ill-requests'                         => '/ILL_requests.html',
 182     'labels/label-edit-batch'                  => '/tools.html#label-batches-label',
 183     'labels/label-edit-layout'                 => '/tools.html#label-layouts-label',
 184     'labels/label-edit-profile'                => '/tools.html#label-profiles-label',
 185     'labels/label-edit-range'                  => '/tools.html#label-creator-label', #FIXME Add when documented
 186     'labels/label-edit-template'               => '/tools.html#label-templates-label',
 187     'labels/label-home'                        => '/tools.html#label-creator-label',
 188     'labels/label-manage'                      => '/tools.html#label-creator-label',
 189     'labels/spinelabel-home'                   => '/tools.html#quick-spine-label-creator',
 190     'mainpage'                                 => '/',
 191     'members/apikeys'                          => '/webservices.html#api-key-management-interface-for-patrons',
 192     'members/boraccount'                       => '/patrons.html#fines',
 193     'members/discharge'                        => '/patrons.html#patron-discharges',
 194     'members/files'                            => '/patrons.html#files',
 195     'members/mancredit'                        => '/patrons.html#creating-manual-credits',
 196     'members/maninvoice'                       => '/patrons.html#creating-manual-invoices',
 197     'members/member-flags'                     => '/patrons.html#patron-permissions',
 198     'members/member-password'                  => '/patrons.html#editing-patrons',
 199     'members/member'                           => '/patrons.html#patron-search',
 200     'members/memberentry'                      => '/patrons.html#add-a-new-patron',
 201     'members/members-home'                     => '/patrons.html',
 202     'members/members-update'                   => '/patrons.html#managing-patron-self-edits',
 203     'members/moremember'                       => '/patrons.html#patron-information',
 204     'members/notices'                          => '/patrons.html#notices',
 205     'members/pay'                              => '/patrons.html#pay/reverse-fines',
 206     'members/paycollect'                       => '/patrons.html#pay/reverse-fines',
 207     'members/purchase-suggestions'             => '/patrons.html#purchase-suggestions',
 208     'members/readingrec'                       => '/patrons.html#circulation-history',
 209     'members/routing-lists'                    => '/patrons.html#routing-lists',
 210     'members/statistics'                       => '/patrons.html#statistics',
 211     'offline_circ/list'                        => '/circulation.html#offline-circulation-utilities',
 212     'offline_circ/process_koc'                 => '/circulation.html#upload-offline-circ-file',
 213     'patron_lists/lists'                       => '/tools.html#patron-lists',
 214     'patroncards/edit-batch'                   => '/tools.html#batches',
 215     'patroncards/edit-layout'                  => '/tools.html#layouts',
 216     'patroncards/edit-profile'                 => '/tools.html#profiles',
 217     'patroncards/edit-template'                => '/tools.html#templates',
 218     'patroncards/home'                         => '/tools.html#patron-card-creator',
 219     'patroncards/image-manage'                 => '/tools.html#manage-images',
 220     'patroncards/manage'                       => '/tools.html#patron-card-creator',
 221     'plugins/plugins-home'                     => '/plugins.html',
 222     'plugins/plugins-upload'                   => '/plugins.html',
 223     'reports/acquisitions_stats'               => '/reports.html#acquisitions-statistics',
 224     'reports/bor_issues_top'                   => '/reports.html#patrons-with-the-most-checkouts',
 225     'reports/borrowers_out'                    => '/reports.html#patrons-with-no-checkouts',
 226     'reports/borrowers_stats'                  => '/reports.html#patron-statistics',
 227     'reports/cat_issues_top'                   => '/reports.html#most-circulated-items',
 228     'reports/catalogue_out'                    => '/reports.html#items-with-no-checkouts',
 229     'reports/catalogue_stats'                  => '/reports.html#catalog-statistics',
 230     'reports/dictionary'                       => '/reports.html#report-dictionary',
 231     'reports/guided_reports'                   => '/reports.html#custom-reports',
 232     'reports/issues_avg_stats'                 => '/reports.html#average-loan-time',
 233     'reports/issues_stats'                     => '/reports.html#circulation-statistics',
 234     'reports/itemslost'                        => '/reports.html#lost-items',
 235     'reports/manager'                          => '/reports.html#catalog-by-item-type',
 236     'reports/reports-home'                     => '/reports.html',
 237     'reports/reserves_stats'                   => '/reports.html#holds-statistics',
 238     'reports/serials_stats'                    => '/reports.html#serials-statistics',
 239     'reserve/request'                          => '/circulation.html#holds',
 240     'reviews/reviewswaiting'                   => '/tools.html#comments',
 241     'rotating_collections/rotatingCollections' => '/tools.html#rotating-collections',
 242     'serials/checkexpiration'                  => '/serials.html#check-serial-expiration',
 243     'serials/claims'                           => '/serials.html#claim-late-serials',
 244     'serials/routing'                          => '/serials.html#create-a-routing-list',
 245     'serials/serials-collection'               => '/serials.html',
 246     'serials/serials-edit'                     => '/serials.html#receive-issues',
 247     'serials/serials-home'                     => '/serials.html',
 248     'serials/subscription-add'                 => '/serials.html#add-a-subscription',
 249     'serials/subscription-detail'              => '/serials.html',
 250     'serials/subscription-frequencies'         => '/serials.html#manage-serial-frequencies',
 251     'serials/subscription-numberpatterns'      => '/serials.html#manage-serial-numbering-patterns',
 252     'suggestion/suggestion'                    => '/acquisitions.html#managing-suggestions',
 253     'tags/list'                                => '/tools.html#tag-moderation',
 254     'tags/review'                              => '/tools.html#tag-moderation',
 255     'tools/automatic_item_modification_by_age' => '/tools.html#automatic-item-modifications-by-age',
 256     'tools/batchMod'                           => '/tools.html#batch-item-deletion',
 257     'tools/batch_delete_records'               => '/tools.html#batch-record-deletion',
 258     'tools/batch_record_modification'          => '/tools.html#batch-record-modification',
 259     'tools/cleanborrowers'                     => '/tools.html#patrons-anonymize-bulk-delete',
 260     'tools/csv-profiles'                       => '/tools.html#csv-profiles',
 261     'tools/export'                             => '/tools.html#export-bibliographic-records',
 262     'tools/holidays'                           => '/tools.html#calendar',
 263     'tools/import_borrowers'                   => '/tools.html#patron-import',
 264     'tools/inventory'                          => '/tools.html#inventory-stocktaking',
 265     'tools/additional-contents'                => '/tools.html#news', # FIXME Needs a change to the manual
 266     'tools/letter'                             => '/tools.html#notices-slips',
 267     'tools/manage-marc-import'                 => '/tools.html#staged-marc-record-management',
 268     'tools/marc_modification_templates'        => '/tools.html#marc-modification-templates',
 269     'tools/modborrowers'                       => '/tools.html#batch-patron-modification',
 270     'tools/overduerules'                       => '/tools.html#overdue-notice-status-triggers',
 271     'tools/picture-upload'                     => '/tools.html#upload-patron-images',
 272     'tools/quotes-upload'                      => '/tools.html#import-quotes',
 273     'tools/quotes'                             => '/tools.html#quote-of-the-day-(qotd)-editor',
 274     'tools/scheduler'                          => '/tools.html#task-scheduler',
 275     'tools/stage-marc-import'                  => '/tools.html#stage-marc-records-for-import',
 276     'tools/tools-home'                         => '/tools.html',
 277     'tools/upload-cover-image'                 => '/tools.html#upload-local-cover-image',
 278     'tools/viewlog'                            => '/tools.html#log-viewer',
 279     'virtualshelves/shelves'                   => '/lists.html#lists',
 280 };
 281
 282 sub get_url {
 283     my ( $url, $preferred_language ) = @_;
 284     my $file;
 285     if ($url =~ /koha\/(.*)\.pl/ || $url =~ '/koha/(erm.*)') {
 286         $file = $1;
 287     } else {
 288         $file = 'mainpage';
 289     }
 290     $file =~ s/[^a-zA-Z0-9_\-\/]*//g;
 291
 292     if ( $file =~ m|^erm| ) {
 293         $file =~ s|\d*$||;
 294     }
 295
 296     my $view;
 297     if ($url =~ /(?:\?|\&)tab=(?<value>[\w+,.-]*)/) {
 298         $view = $file . '#' . $+{value};
 299     }
 300
 301     my $base_url = _get_base_url( $preferred_language );
 302     return $base_url
 303       . (
 304           exists $mapping->{$view} ? $mapping->{$view}
 305         : exists $mapping->{$file} ? $mapping->{$file}
 306         :                            $mapping->{mainpage}
 307       );
 308 }
 309
 310 1;