Koha-community/Koha - Koha - Koha: The world's first free and open source library system

Author	SHA1	Message	Date
Jonathan Druart	9d6d641d1f	Bug 17600: Standardize our EXPORT_OK On bug 17591 we discovered that there was something weird going on with the way we export and use subroutines/modules. This patch tries to standardize our EXPORT to use EXPORT_OK only. That way we will need to explicitely define the subroutine we want to use from a module. This patch is a squashed version of: Bug 17600: After export.pl Bug 17600: After perlimport Bug 17600: Manual changes Bug 17600: Other manual changes after second perlimports run Bug 17600: Fix tests And a lot of other manual changes. export.pl is a dirty script that can be found on bug 17600. "perlimport" is: git clone https://github.com/oalders/App-perlimports.git cd App-perlimports/ cpanm --installdeps . export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib" find . \( -name ".pl" -o -name ".pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \; The ideas of this patch are to: * use EXPORT_OK instead of EXPORT * perltidy the EXPORT_OK list * remove '&' before the subroutine names * remove some uneeded use statements * explicitely import the subroutines we need within the controllers or modules Note that the private subroutines (starting with _) should not be exported (and not used from outside of the module except from tests). EXPORT vs EXPORT_OK (from https://www.thegeekstuff.com/2010/06/perl-exporter-examples/) """ Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members. @EXPORT and @EXPORT_OK are the two main variables used during export operation. @EXPORT contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace. @EXPORT_OK does export of symbols on demand basis. """ If this patch caused a conflict with a patch you wrote prior to its push: * Make sure you are not reintroducing a "use" statement that has been removed * "$subroutine" is not exported by the C4::$MODULE module means that you need to add the subroutine to the @EXPORT_OK list * Bareword "$subroutine" not allowed while "strict subs" means that you didn't imported the subroutine from the module: - use $MODULE qw( $subroutine list ); You can also use the fully qualified namespace: C4::$MODULE::$subroutine Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>	8 years ago
Jonathan Druart	41a8005d10	Bug 28606: Remove $DEBUG and $ENV{DEBUG} We should remove the debug statements or use Koha::Logger when we want to keep it. Test plan: Confirm that occurrences of remaining occurrences of DEBUG need to be kept (historical scripts for instance) Confirm that the occurrences removed by this patch can be removed Confirm that the occurrences replaced by Koha::Logger are correct Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Looks good to me, noting a few minor points on BZ. JD amended patch: replace "warn #Finished" with "#warn Finished", and put the statement on a single line Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>	3 years ago
Martin Renvoize	ba4fb0fdee	Bug 23290: (RM follow-up) Correction to copyright statement We have updated our copyright statements now ;) Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>	4 years ago
Marcel de Rooy	a01e5132c1	Bug 23290: (QA follow-up) Rename option to expand_entities_unsafe When you enable options marked as unsafe, we hope that you know what you are doing. You should, while having access to koha-conf.xml. Test plan: Verify that Security.t still passes. Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>	4 years ago
Marcel de Rooy	a69df1fe61	Bug 23290: (follow-up) Disable expand_entities unless explicitly enabled This follow-up refines the change made in the former patch. See also https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=838097 https://rt.cpan.org/Public/Bug/Display.html?id=118032 We do not want to depend now on the exact LibXML version, so we will disable expand_entities unless it is explicitly enabled via the config variable koha_xslt_security. (Allowing us to test if bad things will be caught.) The options key is now always added to the Security object. The return from set_parser_options has been removed to allow disabling when there is no koha-conf entry (which probably is the normal situation). Test plan: [1] Test the first example patch with and without the other patches (excl. the second example). Toggle expand_entities in koha-conf. Restart Plack and flush the cache each time. Evaluate results with the commit message of first example. [2] Test both example patches with/without other patches. Toggle expand_entities. Restart etc. Evaluate results with commit message of second example (check tmp/breached.txt). Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>	4 years ago
Marcel de Rooy	f6bb3eb478	Bug 23290: Allow enabling expand_entities Since libxml2 disables it now by default, we need to enable it for testing. Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Signed-off-by: David Cook <dcook@prosentient.com.au> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>	5 years ago
Marcel de Rooy	7baa8d349c	Bug 23290: Apply the changes in Security to Base now Until now Base did not yet use Security. The security lines are removed from Base here by calls to Security. A new test must be added still. Test plan: Ensure that t/db_dependent/XSLT_Handler.t still passes. Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Signed-off-by: David Cook <dcook@prosentient.com.au> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>	5 years ago
Marcel de Rooy	269c0bf217	Bug 23290: Introduce Koha::XSLT::Security Also adds a temporary stub for Koha::XSLT_Handler referring to Base. This will be removed later. Test plan: Run t/db_dependent/XSLT_Handler.t Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Signed-off-by: David Cook <dcook@prosentient.com.au> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>	5 years ago
Marcel de Rooy	9ae9e5aade	Bug 23290: Rename XSLT_Handler This is just a git move. Cannot be tested. (Easier for QA.) The next patch adjusts paths etc. in the module. Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Signed-off-by: David Cook <dcook@prosentient.com.au> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>	5 years ago