[Bps-public-commit] apache-session-mariadb branch master created. 040f024abb2868e52eac7493a45f7709b31a8b37
BPS Git Server
git at git.bestpractical.com
Fri Jan 19 14:43:48 UTC 2024
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "apache-session-mariadb".
The branch, master has been created
at 040f024abb2868e52eac7493a45f7709b31a8b37 (commit)
- Log -----------------------------------------------------------------
commit 040f024abb2868e52eac7493a45f7709b31a8b37
Author: sunnavy <sunnavy at bestpractical.com>
Date: Thu Jan 18 17:26:47 2024 -0500
Initial import
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..9fc3618
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+/Apache-Session-MariaDB-*
+/.build
+!META.json
diff --git a/Build.PL b/Build.PL
new file mode 100644
index 0000000..8a8bc92
--- /dev/null
+++ b/Build.PL
@@ -0,0 +1,9 @@
+# This Build.PL for Apache-Session-MariaDB was generated by Dist::Zilla::Plugin::ModuleBuildTiny 0.017.
+use strict;
+use warnings;
+
+
+use 5.006;
+use Module::Build::Tiny 0.034;
+Build_PL();
+
diff --git a/Changes b/Changes
new file mode 100644
index 0000000..321d09b
--- /dev/null
+++ b/Changes
@@ -0,0 +1,2 @@
+{{$NEXT}}
+ - Initial version
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..0c9020e
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,412 @@
+This software is copyright (c) 2024 by Best Practical Solutions, LLC <modules at bestpractical.com>.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+Terms of the Perl programming language system itself
+
+a) the GNU General Public License as published by the Free
+ Software Foundation; either version 1, or (at your option) any
+ later version, or
+b) the "Artistic License"
+
+--- The GNU General Public License, Version 1, February 1989 ---
+
+This software is Copyright (c) 2024 by Best Practical Solutions, LLC <modules at bestpractical.com>.
+
+This is free software, licensed under:
+
+ The GNU General Public License, Version 1, February 1989
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 1, February 1989
+
+ Copyright (C) 1989 Free Software Foundation, Inc.
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The license agreements of most software companies try to keep users
+at the mercy of those companies. By contrast, our General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. The
+General Public License applies to the Free Software Foundation's
+software and to any other program whose authors commit to using it.
+You can use it for your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Specifically, the General Public License is designed to make
+sure that you have the freedom to give away or sell copies of free
+software, that you receive source code or can get it if you want it,
+that you can change the software or use pieces of it in new free
+programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of a such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must tell them their rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any program or other work which
+contains a notice placed by the copyright holder saying it may be
+distributed under the terms of this General Public License. The
+"Program", below, refers to any such program or work, and a "work based
+on the Program" means either the Program or any work containing the
+Program or a portion of it, either verbatim or with modifications. Each
+licensee is addressed as "you".
+
+ 1. You may copy and distribute verbatim copies of the Program's source
+code as you receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice and
+disclaimer of warranty; keep intact all the notices that refer to this
+General Public License and to the absence of any warranty; and give any
+other recipients of the Program a copy of this General Public License
+along with the Program. You may charge a fee for the physical act of
+transferring a copy.
+
+ 2. You may modify your copy or copies of the Program or any portion of
+it, and copy and distribute such modifications under the terms of Paragraph
+1 above, provided that you also do the following:
+
+ a) cause the modified files to carry prominent notices stating that
+ you changed the files and the date of any change; and
+
+ b) cause the whole of any work that you distribute or publish, that
+ in whole or in part contains the Program or any part thereof, either
+ with or without modifications, to be licensed at no charge to all
+ third parties under the terms of this General Public License (except
+ that you may choose to grant warranty protection to some or all
+ third parties, at your option).
+
+ c) If the modified program normally reads commands interactively when
+ run, you must cause it, when started running for such interactive use
+ in the simplest and most usual way, to print or display an
+ announcement including an appropriate copyright notice and a notice
+ that there is no warranty (or else, saying that you provide a
+ warranty) and that users may redistribute the program under these
+ conditions, and telling the user how to view a copy of this General
+ Public License.
+
+ d) You may charge a fee for the physical act of transferring a
+ copy, and you may at your option offer warranty protection in
+ exchange for a fee.
+
+Mere aggregation of another independent work with the Program (or its
+derivative) on a volume of a storage or distribution medium does not bring
+the other work under the scope of these terms.
+
+ 3. You may copy and distribute the Program (or a portion or derivative of
+it, under Paragraph 2) in object code or executable form under the terms of
+Paragraphs 1 and 2 above provided that you also do one of the following:
+
+ a) accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of
+ Paragraphs 1 and 2 above; or,
+
+ b) accompany it with a written offer, valid for at least three
+ years, to give any third party free (except for a nominal charge
+ for the cost of distribution) a complete machine-readable copy of the
+ corresponding source code, to be distributed under the terms of
+ Paragraphs 1 and 2 above; or,
+
+ c) accompany it with the information you received as to where the
+ corresponding source code may be obtained. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form alone.)
+
+Source code for a work means the preferred form of the work for making
+modifications to it. For an executable file, complete source code means
+all the source code for all modules it contains; but, as a special
+exception, it need not include source code for modules which are standard
+libraries that accompany the operating system on which the executable
+file runs, or for standard header files or definitions files that
+accompany that operating system.
+
+ 4. You may not copy, modify, sublicense, distribute or transfer the
+Program except as expressly provided under this General Public License.
+Any attempt otherwise to copy, modify, sublicense, distribute or transfer
+the Program is void, and will automatically terminate your rights to use
+the Program under this License. However, parties who have received
+copies, or rights to use copies, from you under this General Public
+License will not have their licenses terminated so long as such parties
+remain in full compliance.
+
+ 5. By copying, distributing or modifying the Program (or any work based
+on the Program) you indicate your acceptance of this license to do so,
+and all its terms and conditions.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the original
+licensor to copy, distribute or modify the Program subject to these
+terms and conditions. You may not impose any further restrictions on the
+recipients' exercise of the rights granted herein.
+
+ 7. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of the license which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+the license, you may choose any version ever published by the Free Software
+Foundation.
+
+ 8. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ Appendix: How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to humanity, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+ To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively convey
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) 19yy <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 1, or (at your option)
+ any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) 19xx name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the
+appropriate parts of the General Public License. Of course, the
+commands you use may be called something other than `show w' and `show
+c'; they could even be mouse-clicks or menu items--whatever suits your
+program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ program `Gnomovision' (a program to direct compilers to make passes
+ at assemblers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+That's all there is to it!
+
+
+--- The Perl Artistic License 1.0 ---
+
+This software is Copyright (c) 2024 by Best Practical Solutions, LLC <modules at bestpractical.com>.
+
+This is free software, licensed under:
+
+ The Perl Artistic License 1.0
+
+
+
+
+
+ The "Artistic License"
+
+ Preamble
+
+The intent of this document is to state the conditions under which a
+Package may be copied, such that the Copyright Holder maintains some
+semblance of artistic control over the development of the package,
+while giving the users of the package the right to use and distribute
+the Package in a more-or-less customary fashion, plus the right to make
+reasonable modifications.
+
+Definitions:
+
+ "Package" refers to the collection of files distributed by the
+ Copyright Holder, and derivatives of that collection of files
+ created through textual modification.
+
+ "Standard Version" refers to such a Package if it has not been
+ modified, or has been modified in accordance with the wishes
+ of the Copyright Holder as specified below.
+
+ "Copyright Holder" is whoever is named in the copyright or
+ copyrights for the package.
+
+ "You" is you, if you're thinking about copying or distributing
+ this Package.
+
+ "Reasonable copying fee" is whatever you can justify on the
+ basis of media cost, duplication charges, time of people involved,
+ and so on. (You will not be required to justify it to the
+ Copyright Holder, but only to the computing community at large
+ as a market that must bear the fee.)
+
+ "Freely Available" means that no fee is charged for the item
+ itself, though there may be fees involved in handling the item.
+ It also means that recipients of the item may redistribute it
+ under the same conditions they received it.
+
+1. You may make and give away verbatim copies of the source form of the
+Standard Version of this Package without restriction, provided that you
+duplicate all of the original copyright notices and associated disclaimers.
+
+2. You may apply bug fixes, portability fixes and other modifications
+derived from the Public Domain or from the Copyright Holder. A Package
+modified in such a way shall still be considered the Standard Version.
+
+3. You may otherwise modify your copy of this Package in any way, provided
+that you insert a prominent notice in each changed file stating how and
+when you changed that file, and provided that you do at least ONE of the
+following:
+
+ a) place your modifications in the Public Domain or otherwise make them
+ Freely Available, such as by posting said modifications to Usenet or
+ an equivalent medium, or placing the modifications on a major archive
+ site such as uunet.uu.net, or by allowing the Copyright Holder to include
+ your modifications in the Standard Version of the Package.
+
+ b) use the modified Package only within your corporation or organization.
+
+ c) rename any non-standard executables so the names do not conflict
+ with standard executables, which must also be provided, and provide
+ a separate manual page for each non-standard executable that clearly
+ documents how it differs from the Standard Version.
+
+ d) make other distribution arrangements with the Copyright Holder.
+
+4. You may distribute the programs of this Package in object code or
+executable form, provided that you do at least ONE of the following:
+
+ a) distribute a Standard Version of the executables and library files,
+ together with instructions (in the manual page or equivalent) on where
+ to get the Standard Version.
+
+ b) accompany the distribution with the machine-readable source of
+ the Package with your modifications.
+
+ c) give non-standard executables non-standard names, and clearly
+ document the differences in manual pages (or equivalent), together
+ with instructions on where to get the Standard Version.
+
+ d) make other distribution arrangements with the Copyright Holder.
+
+5. You may charge a reasonable copying fee for any distribution of this
+Package. You may charge any fee you choose for support of this
+Package. You may not charge a fee for this Package itself. However,
+you may distribute this Package in aggregate with other (possibly
+commercial) programs as part of a larger (possibly commercial) software
+distribution provided that you do not advertise this Package as a
+product of your own. You may embed this Package's interpreter within
+an executable of yours (by linking); this shall be construed as a mere
+form of aggregation, provided that the complete Standard Version of the
+interpreter is so embedded.
+
+6. The scripts and library files supplied as input to or produced as
+output from the programs of this Package do not automatically fall
+under the copyright of this Package, but belong to whoever generated
+them, and may be sold commercially, and may be aggregated with this
+Package. If such scripts or library files are aggregated with this
+Package via the so-called "undump" or "unexec" methods of producing a
+binary executable image, then distribution of such an image shall
+neither be construed as a distribution of this Package nor shall it
+fall under the restrictions of Paragraphs 3 and 4, provided that you do
+not represent such an executable image as a Standard Version of this
+Package.
+
+7. C subroutines (or comparably compiled subroutines in other
+languages) supplied by you and linked into this Package in order to
+emulate subroutines and variables of the language defined by this
+Package shall not be considered part of this Package, but are the
+equivalent of input as in Paragraph 6, provided these subroutines do
+not change the language in any way that would cause it to fail the
+regression tests for the language.
+
+8. Aggregation of this Package with a commercial distribution is always
+permitted provided that the use of this Package is embedded; that is,
+when no overt attempt is made to make this Package's interfaces visible
+to the end user of the commercial distribution. Such use shall not be
+construed as a distribution of this Package.
+
+9. The name of the Copyright Holder may not be used to endorse or promote
+products derived from this software without specific prior written permission.
+
+10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+
+ The End
+
diff --git a/META.json b/META.json
new file mode 100644
index 0000000..701500b
--- /dev/null
+++ b/META.json
@@ -0,0 +1,63 @@
+{
+ "abstract" : "An implementation of Apache::Session using MariaDB",
+ "author" : [
+ "Best Practical Solutions, LLC <modules at bestpractical.com>"
+ ],
+ "dynamic_config" : 0,
+ "generated_by" : "Dist::Milla version v1.0.22, Dist::Zilla version 6.031, CPAN::Meta::Converter version 2.150010",
+ "license" : [
+ "perl_5"
+ ],
+ "meta-spec" : {
+ "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
+ "version" : 2
+ },
+ "name" : "Apache-Session-MariaDB",
+ "no_index" : {
+ "directory" : [
+ "eg",
+ "examples",
+ "inc",
+ "share",
+ "t",
+ "xt"
+ ]
+ },
+ "prereqs" : {
+ "configure" : {
+ "requires" : {
+ "Module::Build::Tiny" : "0.034"
+ }
+ },
+ "develop" : {
+ "requires" : {
+ "Dist::Milla" : "v1.0.22",
+ "Test::Pod" : "1.41"
+ }
+ },
+ "runtime" : {
+ "requires" : {
+ "Apache::Session" : "0",
+ "DBD::MariaDB" : "0"
+ }
+ }
+ },
+ "release_status" : "stable",
+ "resources" : {
+ "homepage" : "https://github.com/bestpractical/apache-session-mariadb",
+ "repository" : {
+ "type" : "git",
+ "url" : "https://github.com/bestpractical/apache-session-mariadb.git",
+ "web" : "https://github.com/bestpractical/apache-session-mariadb"
+ }
+ },
+ "version" : "0.01",
+ "x_contributors" : [
+ "sunnavy <sunnavy at bestpractical.com>"
+ ],
+ "x_generated_by_perl" : "v5.38.2",
+ "x_serialization_backend" : "Cpanel::JSON::XS version 4.37",
+ "x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later",
+ "x_static_install" : 1
+}
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5fee52
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# NAME
+
+Apache::Session::MariaDB - An implementation of Apache::Session using MariaDB
+
+# SYNOPSIS
+
+ use Apache::Session::MariaDB;
+
+ #if you want Apache::Session to open new DB handles:
+
+ tie %hash, 'Apache::Session::MariaDB', $id, {
+ DataSource => 'dbi:MariaDB:sessions',
+ UserName => $db_user,
+ Password => $db_pass,
+ LockDataSource => 'dbi:MariaDB:sessions',
+ LockUserName => $db_user,
+ LockPassword => $db_pass
+ };
+
+ #or, if your handles are already opened:
+
+ tie %hash, 'Apache::Session::MariaDB', $id, {
+ Handle => $dbh,
+ LockHandle => $dbh
+ };
+
+# DESCRIPTION
+
+This module is an implementation of Apache::Session. It uses the
+MariaDB backing store and the MariaDB locking scheme. See the example,
+and the documentation for Apache::Session::Store::MariaDB and
+Apache::Session::Lock::MariaDB for more details.
+
+It's based on [Apache::Session::MySQL](https://metacpan.org/pod/Apache%3A%3ASession%3A%3AMySQL) but uses [DBD::MariaDB](https://metacpan.org/pod/DBD%3A%3AMariaDB) instead
+of [DBD::mysql](https://metacpan.org/pod/DBD%3A%3Amysql). The initial reason to create this new module is that
+[DBD::MariaDB](https://metacpan.org/pod/DBD%3A%3AMariaDB) requires to explicitly indicate `a_session` column as
+binary in [DBI](https://metacpan.org/pod/DBI)'s bind\_param calls, which is different from [DBD::mysql](https://metacpan.org/pod/DBD%3A%3Amysql)
+and thus [Apache::Session::MySQL](https://metacpan.org/pod/Apache%3A%3ASession%3A%3AMySQL) doesn't support it.
+
+# AUTHOR
+
+Best Practical Solutions, LLC <modules at bestpractical.com>
+
+Jeffrey William Baker <jwbaker at acm.org>
+
+Tomas Doran <bobtfish at bobtfish.net<gt>
+
+# LICENSE AND COPYRIGHT
+
+Copyright (C) 2024, Best Practical Solutions LLC.
+
+This library is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+
+# SEE ALSO
+
+[Apache::Session::MySQL](https://metacpan.org/pod/Apache%3A%3ASession%3A%3AMySQL), [Apache::Session::File](https://metacpan.org/pod/Apache%3A%3ASession%3A%3AFile), [Apache::Session::Flex](https://metacpan.org/pod/Apache%3A%3ASession%3A%3AFlex),
+[Apache::Session::DB\_File](https://metacpan.org/pod/Apache%3A%3ASession%3A%3ADB_File), [Apache::Session::Postgres](https://metacpan.org/pod/Apache%3A%3ASession%3A%3APostgres), [Apache::Session](https://metacpan.org/pod/Apache%3A%3ASession)
diff --git a/cpanfile b/cpanfile
new file mode 100644
index 0000000..4d656c3
--- /dev/null
+++ b/cpanfile
@@ -0,0 +1,2 @@
+requires 'Apache::Session';
+requires 'DBD::MariaDB';
diff --git a/dist.ini b/dist.ini
new file mode 100644
index 0000000..51b5fd2
--- /dev/null
+++ b/dist.ini
@@ -0,0 +1,6 @@
+name = Apache-Session-MariaDB
+
+[@Milla]
+[GithubMeta]
+remote = github
+[Signature]
diff --git a/lib/Apache/Session/Lock/MariaDB.pm b/lib/Apache/Session/Lock/MariaDB.pm
new file mode 100644
index 0000000..b2361d7
--- /dev/null
+++ b/lib/Apache/Session/Lock/MariaDB.pm
@@ -0,0 +1,39 @@
+package Apache::Session::Lock::MariaDB;
+
+use strict;
+use warnings;
+
+use base 'Apache::Session::Lock::MySQL';
+
+1;
+
+=pod
+
+=head1 NAME
+
+Apache::Session::Lock::MariaDB - Provides mutual exclusion using MariaDB
+
+=head1 SYNOPSIS
+
+ use Apache::Session::Lock::MariaDB;
+
+ my $locker = Apache::Session::Lock::MariaDB->new();
+
+ $locker->acquire_read_lock($ref);
+ $locker->acquire_write_lock($ref);
+ $locker->release_read_lock($ref);
+ $locker->release_write_lock($ref);
+ $locker->release_all_locks($ref);
+
+=head1 DESCRIPTION
+
+This is based on L<Apache::Session::Lock::MySQL> but for
+L<Apache::Session::MariaDB>.
+
+=head1 AUTHOR
+
+Best Practical Solutions, LLC E<lt>modules at bestpractical.comE<gt>
+
+=head1 SEE ALSO
+
+L<Apache::Session::Lock::MySQL>, L<Apache::Session>
diff --git a/lib/Apache/Session/MariaDB.pm b/lib/Apache/Session/MariaDB.pm
new file mode 100644
index 0000000..f953386
--- /dev/null
+++ b/lib/Apache/Session/MariaDB.pm
@@ -0,0 +1,91 @@
+package Apache::Session::MariaDB;
+
+use strict;
+use warnings;
+
+use base 'Apache::Session';
+
+our $VERSION = '0.01';
+
+use Apache::Session;
+use Apache::Session::Lock::MariaDB;
+use Apache::Session::Store::MariaDB;
+use Apache::Session::Generate::MD5;
+use Apache::Session::Serialize::Storable;
+
+sub populate {
+ my $self = shift;
+
+ $self->{object_store} = new Apache::Session::Store::MariaDB $self;
+ $self->{lock_manager} = new Apache::Session::Lock::MariaDB $self;
+ $self->{generate} = \&Apache::Session::Generate::MD5::generate;
+ $self->{validate} = \&Apache::Session::Generate::MD5::validate;
+ $self->{serialize} = \&Apache::Session::Serialize::Storable::serialize;
+ $self->{unserialize} = \&Apache::Session::Serialize::Storable::unserialize;
+
+ return $self;
+}
+
+1;
+
+
+=pod
+
+=head1 NAME
+
+Apache::Session::MariaDB - An implementation of Apache::Session using MariaDB
+
+=head1 SYNOPSIS
+
+ use Apache::Session::MariaDB;
+
+ #if you want Apache::Session to open new DB handles:
+
+ tie %hash, 'Apache::Session::MariaDB', $id, {
+ DataSource => 'dbi:MariaDB:sessions',
+ UserName => $db_user,
+ Password => $db_pass,
+ LockDataSource => 'dbi:MariaDB:sessions',
+ LockUserName => $db_user,
+ LockPassword => $db_pass
+ };
+
+ #or, if your handles are already opened:
+
+ tie %hash, 'Apache::Session::MariaDB', $id, {
+ Handle => $dbh,
+ LockHandle => $dbh
+ };
+
+=head1 DESCRIPTION
+
+This module is an implementation of Apache::Session. It uses the
+MariaDB backing store and the MariaDB locking scheme. See the example,
+and the documentation for Apache::Session::Store::MariaDB and
+Apache::Session::Lock::MariaDB for more details.
+
+It's based on L<Apache::Session::MySQL> but uses L<DBD::MariaDB> instead
+of L<DBD::mysql>. The initial reason to create this new module is that
+L<DBD::MariaDB> requires to explicitly indicate C<a_session> column as
+binary in L<DBI>'s bind_param calls, which is different from L<DBD::mysql>
+and thus L<Apache::Session::MySQL> doesn't support it.
+
+=head1 AUTHOR
+
+Best Practical Solutions, LLC E<lt>modules at bestpractical.comE<gt>
+
+Jeffrey William Baker E<lt>jwbaker at acm.orgE<gt>
+
+Tomas Doran E<lt>bobtfish at bobtfish.net<gt>
+
+=head1 LICENSE AND COPYRIGHT
+
+Copyright (C) 2024, Best Practical Solutions LLC.
+
+This library is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+
+=head1 SEE ALSO
+
+L<Apache::Session::MySQL>, L<Apache::Session::File>, L<Apache::Session::Flex>,
+L<Apache::Session::DB_File>, L<Apache::Session::Postgres>, L<Apache::Session>
diff --git a/lib/Apache/Session/MariaDB/NoLock.pm b/lib/Apache/Session/MariaDB/NoLock.pm
new file mode 100644
index 0000000..6a8cb3c
--- /dev/null
+++ b/lib/Apache/Session/MariaDB/NoLock.pm
@@ -0,0 +1,82 @@
+package Apache::Session::MariaDB::NoLock;
+
+use strict;
+use warnings;
+
+use base 'Apache::Session';
+
+use Apache::Session;
+use Apache::Session::Lock::Null;
+use Apache::Session::Store::MariaDB;
+use Apache::Session::Generate::MD5;
+use Apache::Session::Serialize::Storable;
+
+sub populate {
+ my $self = shift;
+
+ $self->{object_store} = Apache::Session::Store::MariaDB->new($self);
+ $self->{lock_manager} = Apache::Session::Lock::Null->new($self);
+ $self->{generate} = \&Apache::Session::Generate::MD5::generate;
+ $self->{validate} = \&Apache::Session::Generate::MD5::validate;
+ $self->{serialize} = \&Apache::Session::Serialize::Storable::serialize;
+ $self->{unserialize} = \&Apache::Session::Serialize::Storable::unserialize;
+
+ return $self;
+}
+
+1;
+
+=pod
+
+=head1 NAME
+
+Apache::Session::MariaDB::NoLock - An implementation of Apache::Session::MariaDB without locking
+
+=head1 SYNOPSIS
+
+ use Apache::Session::MariaDB::NoLock;
+
+ #if you want Apache::Session to open new DB handles:
+
+ tie %hash, 'Apache::Session::MariaDB::NoLock', $id, {
+ DataSource => 'dbi:MariaDB:sessions',
+ UserName => $db_user,
+ Password => $db_pass,
+ };
+
+ #or, if your handles are already opened:
+
+ tie %hash, 'Apache::Session::MariaDB::NoLock', $id, {
+ Handle => $dbh,
+ };
+
+ To configure the non-locking session store in RT (what I use this module for),
+ put the following into your C<RT_SiteConfig.pm> module:
+
+ Set($WebSessionClass , 'Apache::Session::MariaDB::NoLock');
+
+=head1 DESCRIPTION
+
+This module is an implementation of Apache::Session. It uses the MariaDB backing
+store and the Null locking scheme. See the example, and the documentation for
+Apache::Session::Store::MariaDB for more details.
+
+=head1 WARNING
+
+This module explicitly B<DOES NOT DO ANY LOCKING>. This can cause your session
+data to be overwritten or stale data to be read by subsequent requests.
+
+This B<CAN CAUSE LARGE PROBLEMS IN YOUR APPLICATION>.
+
+=head1 AUTHOR
+
+Best Practical Solutions, LLC E<lt>modules at bestpractical.comE<gt>
+
+Tomas Doran E<lt>bobtfish at bobtfish.net<gt>
+
+=head1 SEE ALSO
+
+L<Apache::Session::MariaDB>, L<Apache::Session::Flex>,
+L<Apache::Session>
+
+=cut
diff --git a/lib/Apache/Session/Store/MariaDB.pm b/lib/Apache/Session/Store/MariaDB.pm
new file mode 100644
index 0000000..12099b7
--- /dev/null
+++ b/lib/Apache/Session/Store/MariaDB.pm
@@ -0,0 +1,184 @@
+package Apache::Session::Store::MariaDB;
+
+use strict;
+
+use DBI;
+use Apache::Session::Store::DBI;
+
+use base 'Apache::Session::Store::DBI';
+
+$Apache::Session::Store::MariaDB::DataSource = undef;
+$Apache::Session::Store::MariaDB::UserName = undef;
+$Apache::Session::Store::MariaDB::Password = undef;
+
+sub connection {
+ my $self = shift;
+ my $session = shift;
+
+ return if ( defined $self->{dbh} );
+
+ $self->{'table_name'} = $session->{args}->{TableName} || $Apache::Session::Store::DBI::TableName;
+
+ if ( exists $session->{args}->{Handle} ) {
+ $self->{dbh} = $session->{args}->{Handle};
+ return;
+ }
+
+ my $datasource = $session->{args}->{DataSource}
+ || $Apache::Session::Store::MariaDB::DataSource;
+ my $username = $session->{args}->{UserName}
+ || $Apache::Session::Store::MariaDB::UserName;
+ my $password = $session->{args}->{Password}
+ || $Apache::Session::Store::MariaDB::Password;
+
+ $self->{dbh} = DBI->connect( $datasource, $username, $password, { RaiseError => 1, AutoCommit => 1 } )
+ || die $DBI::errstr;
+
+
+ #If we open the connection, we close the connection
+ $self->{disconnect} = 1;
+}
+
+sub DESTROY {
+ my $self = shift;
+
+ if ( $self->{disconnect} ) {
+ $self->{dbh}->disconnect;
+ }
+}
+
+# DBD::MariaDB requires to explicitly indicate a_session is a binary field
+sub insert {
+ my $self = shift;
+ my $session = shift;
+
+ $self->connection($session);
+
+ local $self->{dbh}->{RaiseError} = 1;
+
+ if ( !defined $self->{insert_sth} ) {
+ $self->{insert_sth} = $self->{dbh}->prepare_cached(
+ qq{
+ INSERT INTO $self->{'table_name'} (id, a_session) VALUES (?,?)}
+ );
+ }
+
+ $self->{insert_sth}->bind_param( 1, $session->{data}->{_session_id} );
+ $self->{insert_sth}->bind_param( 2, $session->{serialized}, DBI::SQL_BLOB );
+
+ $self->{insert_sth}->execute;
+
+ $self->{insert_sth}->finish;
+}
+
+
+sub update {
+ my $self = shift;
+ my $session = shift;
+
+ $self->connection($session);
+
+ local $self->{dbh}->{RaiseError} = 1;
+
+ if ( !defined $self->{update_sth} ) {
+ $self->{update_sth} = $self->{dbh}->prepare_cached(
+ qq{
+ UPDATE $self->{'table_name'} SET a_session = ? WHERE id = ?}
+ );
+ }
+
+ $self->{update_sth}->bind_param( 1, $session->{serialized}, DBI::SQL_BLOB );
+ $self->{update_sth}->bind_param( 2, $session->{data}->{_session_id} );
+
+ $self->{update_sth}->execute;
+
+ $self->{update_sth}->finish;
+}
+
+1;
+
+=pod
+
+=head1 NAME
+
+Apache::Session::Store::MariaDB - Store persistent data in a MariaDB database
+
+=head1 SYNOPSIS
+
+ use Apache::Session::Store::MariaDB;
+
+ my $store = new Apache::Session::Store::MariaDB;
+
+ $store->insert($ref);
+ $store->update($ref);
+ $store->materialize($ref);
+ $store->remove($ref);
+
+=head1 DESCRIPTION
+
+Apache::Session::Store::MariaDB fulfills the storage interface of .
+Apache::Session Session data is stored in a MariaDB database .
+
+=head1 SCHEMA
+
+To use this module, you will need at least these columns in a table called
+'sessions', or another table name if you provide the TableName argument:
+
+ id char(32) # or however long your session IDs are.
+ a_session blob # or longblob if you plan to use a big session (>64k after serialization)
+
+To create this schema, you can execute this command using the MariaDB
+program:
+
+ CREATE TABLE sessions (
+ id char(32) not null primary key,
+ a_session blob
+ );
+
+If you use some other command, ensure that there is a unique index on the
+table's id column.
+
+=head1 CONFIGURATION
+
+The module must know what datasource, username, and password to use when
+connecting to the database. These values can be set using the options hash
+(see Apache::Session documentation). The options are:
+
+=over 4
+
+=item DataSource
+
+=item UserName
+
+=item Password
+
+=item TableName
+
+=item Handle
+
+=back
+
+Example:
+
+ tie %hash, 'Apache::Session::MariaDB', $id, {
+ DataSource => 'dbi:MariaDB:database',
+ UserName => 'database_user',
+ Password => 'K00l',
+ TableName => 'sessions'
+ };
+
+Instead, you may pass in an already-opened DBI handle to your database.
+
+ tie %hash, 'Apache::Session::MariaDB', $id, {
+ Handle => $dbh
+ };
+
+=head1 AUTHOR
+
+Best Practical Solutions, LLC E<lt>modules at bestpractical.comE<gt>
+
+Jeffrey William Baker E<lt>jwbaker at acm.orgE<gt>
+
+=head1 SEE ALSO
+
+L<Apache::Session>
diff --git a/t/basics.t b/t/basics.t
new file mode 100644
index 0000000..c22fdc2
--- /dev/null
+++ b/t/basics.t
@@ -0,0 +1,192 @@
+# ported from t/99mysql.t in Apache-Session
+
+use Test::More;
+use Test::Deep;
+
+plan skip_all => "Set APACHE_SESSION_MARIADB_TEST to run this test"
+ unless $ENV{APACHE_SESSION_MARIADB_TEST};
+
+
+my $hostname = $ENV{APACHE_SESSION_MARIADB_TEST_HOST};
+my $port = $ENV{APACHE_SESSION_MARIADB_TEST_PORT};
+my $dsn = "DBI:MariaDB:database=$ENV{APACHE_SESSION_MARIADB_TEST}";
+$dsn .= ";host=$ENV{APACHE_SESSION_MARIADB_TEST_HOST}" if $ENV{APACHE_SESSION_MARIADB_TEST_HOST};
+$dsn .= ";port=$ENV{APACHE_SESSION_MARIADB_TEST_PORT}" if $ENV{APACHE_SESSION_MARIADB_TEST_PORT};
+
+my $uname = $ENV{APACHE_SESSION_MARIADB_TEST_USER} || 'root';
+my $upass = $ENV{APACHE_SESSION_MARIADB_TEST_PASS} || '';
+
+use DBI;
+my $dbh = DBI->connect( $dsn, $uname, $upass, { RaiseError => 1 } );
+
+my $package = 'Apache::Session::MariaDB';
+use_ok $package;
+
+my @tables_used = qw/sessions s/;
+
+sub drop_tables {
+ my $dbh = shift;
+ my $dblist = join( ', ', @_ );
+ my $res = $dbh->do("DROP TABLE IF EXISTS $dblist");
+ if ( !defined $res and $dbh->errstr =~ /Cannot delete or update a parent row: a foreign key constraint/ ) {
+ my $ary_ref = $dbh->selectcol_arrayref('SHOW TABLES');
+ $dblist = join( ', ', @$ary_ref );
+ diag "Found foreign key constraint, trying to drop all tables from DB";
+
+ $dbh->do("SET foreign_key_checks = 0");
+ $dbh->do("DROP TABLE IF EXISTS $dblist");
+ $dbh->do("SET foreign_key_checks = 1");
+ }
+}
+
+{
+ drop_tables( $dbh, @tables_used );
+ foreach my $table (@tables_used) {
+ $dbh->do(<<"EOT");
+ CREATE TABLE $table (
+ id char(32) not null primary key,
+ a_session blob
+ );
+EOT
+ }
+}
+
+my $session = {};
+
+tie %{$session}, $package, undef,
+ {
+ DataSource => $dsn,
+ UserName => $uname,
+ Password => $upass,
+ LockDataSource => $dsn,
+ LockUserName => $uname,
+ LockPassword => $upass,
+ };
+
+ok tied( %{$session} ), 'session tied';
+
+ok exists( $session->{_session_id} ), 'session id exists';
+
+my $id = $session->{_session_id};
+
+my $foo = $session->{foo} = 'bar';
+my $baz = $session->{baz} = [ 'tom', 'dick', 'harry' ];
+my $test_value = $session->{'test'} = 12; #test for RT#50896
+
+untie %{$session};
+undef $session;
+$session = {};
+
+tie %{$session}, $package, $id,
+ {
+ DataSource => $dsn,
+ UserName => $uname,
+ Password => $upass,
+ LockDataSource => $dsn,
+ LockUserName => $uname,
+ LockPassword => $upass,
+ };
+
+ok tied( %{$session} ), 'session tied';
+
+is $session->{_session_id}, $id, 'id retrieved matches one stored';
+
+cmp_deeply $session->{foo}, $foo, "Foo matches";
+cmp_deeply $session->{baz}, $baz, "Baz matches";
+cmp_deeply $session->{test}, $test_value, "test matches";
+
+untie %{$session};
+undef $session;
+$session = {};
+
+{
+
+ tie %{$session}, $package, undef,
+ {
+ TableName => 's',
+ DataSource => $dsn,
+ UserName => $uname,
+ Password => $upass,
+ LockDataSource => $dsn,
+ LockUserName => $uname,
+ LockPassword => $upass,
+ };
+
+ ok tied( %{$session} ), 'session tied';
+
+ ok exists( $session->{_session_id} ), 'session id exists';
+ my $id1 = $session->{_session_id};
+
+ $session{'test'} = 13;
+
+ untie %{$session};
+ undef $session;
+ $session = {};
+
+ tie %{$session}, $package, $id1,
+ {
+ TableName => 's',
+ DataSource => $dsn,
+ UserName => $uname,
+ Password => $upass,
+ LockDataSource => $dsn,
+ LockUserName => $uname,
+ LockPassword => $upass,
+ };
+
+ ok tied( %{$session} ), 'session tied';
+
+ ok exists( $session->{_session_id} ), 'session id exists';
+
+ is( $session->{_session_id}, $id1, 'session id is correct' );
+ is( $session{'test'}, 13, 'correct value retrieved' );
+
+ untie %{$session};
+ undef $session;
+ $session = {};
+
+ tie %{$session}, $package, $id1, { #test for RT#50896
+ TableName => 's',
+ DataSource => $dsn,
+ UserName => $uname,
+ Password => $upass,
+ LockDataSource => $dsn,
+ LockUserName => $uname,
+ LockPassword => $upass,
+ };
+
+ ok tied( %{$session} ), 'session tied';
+
+ ok exists( $session->{_session_id} ), 'session id exists';
+
+ is( $session->{_session_id}, $id1, 'session id is correct' );
+ is( $session{'test'}, 13, 'correct value retrieved' );
+
+}
+
+
+untie %{$session};
+undef $session;
+$session = {};
+
+my $dbh = DBI->connect( $dsn, $uname, $upass, { RaiseError => 1 } );
+
+tie %{$session}, $package, $id,
+ {
+ Handle => $dbh,
+ LockHandle => $dbh,
+ };
+
+ok tied( %{$session} ), 'session tied';
+
+is $session->{_session_id}, $id, 'id retrieved matches one stored';
+
+cmp_deeply $session->{foo}, $foo, "Foo matches";
+cmp_deeply $session->{baz}, $baz, "Baz matches";
+cmp_deeply $session->{'test'}, $test_value, "test matches";
+
+tied( %{$session} )->delete;
+untie %{$session};
+$dbh->disconnect;
+
+done_testing;
diff --git a/t/load.t b/t/load.t
new file mode 100644
index 0000000..ce448fd
--- /dev/null
+++ b/t/load.t
@@ -0,0 +1,6 @@
+use Test::More;
+
+use_ok('Apache::Session::MariaDB');
+use_ok('Apache::Session::MariaDB::NoLock');
+
+done_testing;
-----------------------------------------------------------------------
hooks/post-receive
--
apache-session-mariadb
More information about the Bps-public-commit
mailing list