diff options
author | Andrew Shadura <andrewsh@debian.org> | 2017-09-08 15:28:52 +0100 |
---|---|---|
committer | Andrew Shadura <andrewsh@debian.org> | 2017-09-08 15:28:52 +0100 |
commit | 22e0251c5d32c051fcfb9b0e7069e67bea26f518 (patch) | |
tree | b931235d262ec9b4b46e01c0c6460f4570603b87 |
Import original source of Parse-MIME 1.003
-rw-r--r-- | Changes | 20 | ||||
-rw-r--r-- | LICENSE | 379 | ||||
-rw-r--r-- | MANIFEST | 17 | ||||
-rw-r--r-- | META.json | 56 | ||||
-rw-r--r-- | META.yml | 32 | ||||
-rw-r--r-- | Makefile.PL | 73 | ||||
-rw-r--r-- | README | 30 | ||||
-rw-r--r-- | dist.ini | 24 | ||||
-rw-r--r-- | lib/Parse/MIME.pm | 229 | ||||
-rw-r--r-- | t/00-compile.t | 73 | ||||
-rw-r--r-- | t/01-parse_mime_type.t | 16 | ||||
-rw-r--r-- | t/02-parse_media_range.t | 16 | ||||
-rw-r--r-- | t/03-quality.t | 20 | ||||
-rw-r--r-- | t/04-best_match.t | 23 | ||||
-rw-r--r-- | t/lib/TestParseMIME.pm | 27 | ||||
-rw-r--r-- | t/lib/fixtures.json | 70 |
16 files changed, 1105 insertions, 0 deletions
@@ -0,0 +1,20 @@ +Revision history for Parse-MIME + +1.003 Sat 10 Jan 2015 + - No functional changes + - No longer contains INSTALL file with install-as-root instructions + +1.002 Mon 05 Jan 2014 + - No functional changes. + - Specified 5.6 minimum Perl requirement. + - Cleaned up test suite. + +1.001 Thu 10 Jul 2014 + - Bump Dist::Zilla version and re-release to fix deps. + No code changes. (Spotted by Olaf Alders.) + +1.000 Fri 03 Aug 2012 + - Initial CPAN release. + +0.001 Sun 21 Dec 2008 + - Initial release. @@ -0,0 +1,379 @@ +This software is copyright (c) 2015 by Aristotle Pagaltzis. + +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) 2015 by Aristotle Pagaltzis. + +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, Suite 500, Boston, MA 02110-1335 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 Artistic License 1.0 --- + +This software is Copyright (c) 2015 by Aristotle Pagaltzis. + +This is free software, licensed under: + + The 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. + - "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 ftp.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) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting 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. + +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 whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..05ecb89 --- /dev/null +++ b/MANIFEST @@ -0,0 +1,17 @@ +# This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.030. +Changes +LICENSE +MANIFEST +META.json +META.yml +Makefile.PL +README +dist.ini +lib/Parse/MIME.pm +t/00-compile.t +t/01-parse_mime_type.t +t/02-parse_media_range.t +t/03-quality.t +t/04-best_match.t +t/lib/TestParseMIME.pm +t/lib/fixtures.json diff --git a/META.json b/META.json new file mode 100644 index 0000000..4f85d4b --- /dev/null +++ b/META.json @@ -0,0 +1,56 @@ +{ + "abstract" : "Parse mime-types, match against media ranges", + "author" : [ + "Aristotle Pagaltzis <pagaltzis@gmx.de>" + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Zilla version 5.030, CPAN::Meta::Converter version 2.143240", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : "2" + }, + "name" : "Parse-MIME", + "prereqs" : { + "configure" : { + "requires" : { + "ExtUtils::MakeMaker" : "0" + } + }, + "runtime" : { + "requires" : { + "Exporter" : "0", + "perl" : "5.006", + "strict" : "0", + "warnings" : "0" + } + }, + "test" : { + "requires" : { + "File::Basename" : "0", + "File::Find" : "0", + "File::Temp" : "0", + "JSON::XS" : "0", + "List::Util" : "0", + "Test::More" : "0", + "constant" : "0", + "lib" : "0" + } + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "http://github.com/ap/Parse-MIME/issues" + }, + "homepage" : "http://github.com/ap/Parse-MIME", + "repository" : { + "type" : "git", + "url" : "git://github.com/ap/Parse-MIME" + } + }, + "version" : "1.003" +} + diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..52a77a5 --- /dev/null +++ b/META.yml @@ -0,0 +1,32 @@ +--- +abstract: 'Parse mime-types, match against media ranges' +author: + - 'Aristotle Pagaltzis <pagaltzis@gmx.de>' +build_requires: + File::Basename: 0 + File::Find: 0 + File::Temp: 0 + JSON::XS: 0 + List::Util: 0 + Test::More: 0 + constant: 0 + lib: 0 +configure_requires: + ExtUtils::MakeMaker: 0 +dynamic_config: 0 +generated_by: 'Dist::Zilla version 5.030, CPAN::Meta::Converter version 2.143240' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: 1.4 +name: Parse-MIME +requires: + Exporter: 0 + perl: 5.006 + strict: 0 + warnings: 0 +resources: + bugtracker: http://github.com/ap/Parse-MIME/issues + homepage: http://github.com/ap/Parse-MIME + repository: git://github.com/ap/Parse-MIME +version: 1.003 diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..b3d27ec --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,73 @@ + +# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.030. +use strict; +use warnings; + +use 5.006; + +use ExtUtils::MakeMaker; + + + +my %WriteMakefileArgs = ( + "ABSTRACT" => "Parse mime-types, match against media ranges", + "AUTHOR" => "Aristotle Pagaltzis <pagaltzis\@gmx.de>", + "CONFIGURE_REQUIRES" => { + "ExtUtils::MakeMaker" => 0 + }, + "DISTNAME" => "Parse-MIME", + "EXE_FILES" => [], + "LICENSE" => "perl", + "MIN_PERL_VERSION" => "5.006", + "NAME" => "Parse::MIME", + "PREREQ_PM" => { + "Exporter" => 0, + "strict" => 0, + "warnings" => 0 + }, + "TEST_REQUIRES" => { + "File::Basename" => 0, + "File::Find" => 0, + "File::Temp" => 0, + "JSON::XS" => 0, + "List::Util" => 0, + "Test::More" => 0, + "constant" => 0, + "lib" => 0 + }, + "VERSION" => "1.003", + "test" => { + "TESTS" => "t/*.t" + } +); + + +my %FallbackPrereqs = ( + "Exporter" => 0, + "ExtUtils::MakeMaker" => 0, + "File::Basename" => 0, + "File::Find" => 0, + "File::Temp" => 0, + "JSON::XS" => 0, + "List::Util" => 0, + "Test::More" => 0, + "constant" => 0, + "lib" => 0, + "strict" => 0, + "warnings" => 0 +); + + +unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { + delete $WriteMakefileArgs{TEST_REQUIRES}; + delete $WriteMakefileArgs{BUILD_REQUIRES}; + $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; +} + +delete $WriteMakefileArgs{CONFIGURE_REQUIRES} + unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; + +WriteMakefile(%WriteMakefileArgs); + + + @@ -0,0 +1,30 @@ +Parse::MIME + +This module provides basic functions for handling mime-types. It can +handle matching mime-types against a list of media-ranges. See section +14.1 of the HTTP specification [RFC 2616] for a complete explanation: +<http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1> + +INSTALLATION + +This is a Perl module distribution. It should be installed with whichever +tool you use to manage your installation of Perl, e.g. any of + + cpanm . + cpan . + cpanp -i . + +Consult http://www.cpan.org/modules/INSTALL.html for further instruction. +Should you wish to install this module manually, the procedure is + + perl Makefile.PL + make + make test + make install + +COPYRIGHT AND LICENSE + +This software is copyright (c) 2015 by Aristotle Pagaltzis. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..e683a6e --- /dev/null +++ b/dist.ini @@ -0,0 +1,24 @@ +name = Parse-MIME +version = 1.003 +author = Aristotle Pagaltzis <pagaltzis@gmx.de> +license = Perl_5 +copyright_holder = Aristotle Pagaltzis +copyright_year = 2015 + +[MetaResources] +homepage = http://github.com/ap/Parse-MIME +bugtracker = http://github.com/ap/Parse-MIME/issues +repository = git://github.com/ap/Parse-MIME + +[@Filter] +-bundle=@Basic +-remove=Readme +[Readme::Brief] +[ReadmeAnyFromPod / PodInRoot] +[MetaJSON] +[PkgVersion] +[PodWeaver] +[CheckChangeLog] +[Test::Compile] +[AutoPrereqs] +[CheckSelfDependency] diff --git a/lib/Parse/MIME.pm b/lib/Parse/MIME.pm new file mode 100644 index 0000000..7466bae --- /dev/null +++ b/lib/Parse/MIME.pm @@ -0,0 +1,229 @@ +use 5.006; +use strict; +use warnings; + +package Parse::MIME; +$Parse::MIME::VERSION = '1.003'; +# ABSTRACT: Parse mime-types, match against media ranges + +use Exporter 'import'; +our @EXPORT_OK = qw( + &parse_mime_type &parse_media_range &parse_media_range_list + &fitness_and_quality_parsed &quality_parsed &quality + &best_match +); +our %EXPORT_TAGS = ( all => \@EXPORT_OK ); + +sub _numify($) { no warnings 'numeric'; 0 + shift } + +# takes any number of args and returns copies stripped of surrounding whitespace +sub _strip { s/\A +//, s/ +\z// for my @s = @_; @s[ 0 .. $#s ] } + +# check whether first two args are equal or one of them is a wildcard +sub _match { $_[0] eq $_[1] or grep { $_ eq '*' } @_[0,1] } + +sub parse_mime_type { + my ( $mime_type ) = @_; + + my @part = split /;/, $mime_type; + my $full_type = _strip shift @part; + my %param = map { _strip split /=/, $_, 2 } @part; + + # Java URLConnection class sends an Accept header that includes a single "*" + # Turn it into a legal wildcard. + $full_type = '*/*' if $full_type eq '*'; + + my ( $type, $subtype ) = _strip split m!/!, $full_type; + + return ( $type, $subtype, \%param ); +} + +sub parse_media_range { + my ( $range ) = @_; + + my ( $type, $subtype, $param ) = parse_mime_type $range; + + $param->{'q'} = 1 + unless defined $param->{'q'} + and length $param->{'q'} + and _numify $param->{'q'} <= 1 + and _numify $param->{'q'} >= 0; + + return ( $type, $subtype, $param ); +} + +sub parse_media_range_list { + my ( $media_range_list ) = @_; + return map { parse_media_range $_ } split /,/, $media_range_list; +} + +sub fitness_and_quality_parsed { + my ( $mime_type, @parsed_ranges ) = @_; + + my ( $best_fitness, $best_fit_q ) = ( -1, 0 ); + + my ( $target_type, $target_subtype, $target_param ) + = parse_media_range $mime_type; + + while ( my ( $type, $subtype, $param ) = splice @parsed_ranges, 0, 3 ) { + + if ( _match( $type, $target_type ) and _match( $subtype, $target_subtype ) ) { + + my $fitness + = ( $type eq $target_type ? 100 : 0 ) + + ( $subtype eq $target_subtype ? 10 : 0 ) + ; + + while ( my ( $k, $v ) = each %$param ) { + ++$fitness + if $k ne 'q' + and exists $target_param->{ $k } + and $target_param->{ $k } eq $v; + } + + ( $best_fitness, $best_fit_q ) = ( $fitness, $param->{'q'} ) + if $fitness > $best_fitness; + } + } + + return ( $best_fitness, _numify $best_fit_q ); +} + +sub quality_parsed { + return +( fitness_and_quality_parsed @_ )[1]; +} + +sub quality { + my ( $mime_type, $ranges ) = @_; + my @parsed_range = parse_media_range_list $ranges; + return quality_parsed $mime_type, @parsed_range; +} + +sub best_match { + my ( $supported, $header ) = @_; + my @parsed_header = parse_media_range_list $header; + + # fitness_and_quality_parsed will return fitness -1 on failure, + # so we want to start with an invalid value greater than that + my ( $best_fitness, $best_fit_q, $match ) = ( -.5, 0 ); + + for my $type ( @$supported ) { + my ( $fitness, $fit_q ) = fitness_and_quality_parsed $type, @parsed_header; + next if $fitness < $best_fitness; + next if $fitness == $best_fitness and $fit_q < $best_fit_q; + ( $best_fitness, $best_fit_q, $match ) = ( $fitness, $fit_q, $type ); + } + + return if not defined $match; + return $match; +} + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +Parse::MIME - Parse mime-types, match against media ranges + +=head1 VERSION + +version 1.003 + +=head1 SYNOPSIS + + use Parse::MIME qw( best_match ); + print best_match( [ qw( application/xbel+xml text/xml ) ], 'text/*;q=0.5,*/*; q=0.1' ); + # text/xml + +=head1 DESCRIPTION + +This module provides basic functions for handling mime-types. It can handle +matching mime-types against a list of media-ranges. See section 14.1 of the +HTTP specification [RFC 2616] for a complete explanation: +L<http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1> + +=head1 INTERFACE + +None of the following functions are exported by default. You can use the +C<:all> tag to import all of them into your package: + + use Parse::MIME ':all'; + +=head2 parse_mime_type + +Parses a mime-type into its component parts and returns type, subtype and +params, where params is a reference to a hash of all the parameters for the +media range: + + parse_mime_type 'application/xhtml;q=0.5' + # ( 'application', 'xhtml', { q => 0.5 } ) + +=head2 parse_media_range + +Media-ranges are mime-types with wild-cards and a C<q> quality parameter. This +function works just like L</parse_mime_type>, but also guarantees that there is +a value for C<q> in the params hash, supplying the default value if necessary. + + parse_media_range 'application/xhtml' + # ( 'application', 'xhtml', { q => 1 } ) + +=head2 parse_media_range_list + +Media-range lists are comma-separated lists of media ranges. This function +works just like L</parse_media_range>, but accepts a list of media ranges and +returns for all of media-ranges. + + my @l = parse_media_range_list 'application/xhtml, text/html;q=0.7' + # ( 'application', 'xhtml', { q => 1 }, 'text', 'html', { q => 0.7 } ) + +=head2 fitness_and_quality_parsed + +Find the best match for a given mime-type (passed as the first parameter) +against a list of media ranges that have already been parsed by +L</parse_media_range> (passed as a flat list). Returns the fitness value and +the value of the C<q> quality parameter of the best match, or C<( -1, 0 )> if +no match was found. + + # for @l see above + fitness_and_quality_parsed( 'text/html', @l ) + # ( 110, 0.7 ) + +=head2 quality + +Determines the quality (C<q>) of a mime-type (passed as the first parameter) +when compared against a media-range list string. F.ex.: + + quality( 'text/html', 'text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5' ) + # 0.7 + +=head2 quality_parsed + +Just like L</quality>, except the second parameter must be pre-parsed by +L</parse_media_range_list>. + +=head2 best_match + +Choose the mime-type with the highest quality (C<q>) from a list of candidates. +Takes an array of supported mime-types as the first parameter and finds the +best match for all the media-ranges listed in header, which is passed as the +second parameter. The value of header must be a string that conforms to the +format of the HTTP C<Accept> header. F.ex.: + + best_match( [ qw( application/xbel+xml text/xml ) ], 'text/*;q=0.5,*/*; q=0.1' ) + # 'text/xml' + +=head1 AUTHOR + +Aristotle Pagaltzis <pagaltzis@gmx.de> + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2015 by Aristotle Pagaltzis. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +=cut diff --git a/t/00-compile.t b/t/00-compile.t new file mode 100644 index 0000000..6771e12 --- /dev/null +++ b/t/00-compile.t @@ -0,0 +1,73 @@ +#!perl + +use strict; +use warnings; + +use Test::More; + + + +use File::Find; +use File::Temp qw{ tempdir }; + +my @modules; +find( + sub { + return if $File::Find::name !~ /\.pm\z/; + my $found = $File::Find::name; + $found =~ s{^lib/}{}; + $found =~ s{[/\\]}{::}g; + $found =~ s/\.pm$//; + # nothing to skip + push @modules, $found; + }, + 'lib', +); + +sub _find_scripts { + my $dir = shift @_; + + my @found_scripts = (); + find( + sub { + return unless -f; + my $found = $File::Find::name; + # nothing to skip + open my $FH, '<', $_ or do { + note( "Unable to open $found in ( $! ), skipping" ); + return; + }; + my $shebang = <$FH>; + return unless $shebang =~ /^#!.*?\bperl\b\s*$/; + push @found_scripts, $found; + }, + $dir, + ); + + return @found_scripts; +} + +my @scripts; +do { push @scripts, _find_scripts($_) if -d $_ } + for qw{ bin script scripts }; + +my $plan = scalar(@modules) + scalar(@scripts); +$plan ? (plan tests => $plan) : (plan skip_all => "no tests to run"); + +{ + # fake home for cpan-testers + # no fake requested ## local $ENV{HOME} = tempdir( CLEANUP => 1 ); + + like( qx{ $^X -Ilib -e "require $_; print '$_ ok'" }, qr/^\s*$_ ok/s, "$_ loaded ok" ) + for sort @modules; + + SKIP: { + eval "use Test::Script 1.05; 1;"; + skip "Test::Script needed to test script compilation", scalar(@scripts) if $@; + foreach my $file ( @scripts ) { + my $script = $file; + $script =~ s!.*/!!; + script_compiles( $file, "$script script compiles" ); + } + } +} diff --git a/t/01-parse_mime_type.t b/t/01-parse_mime_type.t new file mode 100644 index 0000000..37a0847 --- /dev/null +++ b/t/01-parse_mime_type.t @@ -0,0 +1,16 @@ +#!/usr/bin/perl +use strict; +use warnings; + +use Test::More; +use Parse::MIME 'parse_mime_type'; + +use lib 't/lib'; +use TestParseMIME; +my $testcase = TestParseMIME::load_data $0; + +plan tests => 0 + keys %$testcase; + +while ( my ( $mime, $parsed ) = each %$testcase ) { + is_deeply [ parse_mime_type $mime ], $parsed, $mime; +} diff --git a/t/02-parse_media_range.t b/t/02-parse_media_range.t new file mode 100644 index 0000000..4f48949 --- /dev/null +++ b/t/02-parse_media_range.t @@ -0,0 +1,16 @@ +#!/usr/bin/perl +use strict; +use warnings; + +use Test::More; +use Parse::MIME 'parse_media_range'; + +use lib 't/lib'; +use TestParseMIME; +my $testcase = TestParseMIME::load_data $0; + +plan tests => 0 + keys %$testcase; + +while ( my ( $range, $parsed ) = each %$testcase ) { + is_deeply [ parse_media_range $range ], $parsed, $range; +} diff --git a/t/03-quality.t b/t/03-quality.t new file mode 100644 index 0000000..b850691 --- /dev/null +++ b/t/03-quality.t @@ -0,0 +1,20 @@ +#!/usr/bin/perl +use strict; +use warnings; + +use Test::More; +use Parse::MIME 'quality'; + +use lib 't/lib'; +use TestParseMIME; +my $testcase = TestParseMIME::load_data $0; + +use List::Util 'sum'; +plan tests => 0 + sum map { 0 + keys %{ $_->{testcases} } } @$testcase; + +for my $group ( @$testcase ) { +my $accept = $group->{ accept }; + while ( my ( $type, $quality ) = each %{ $group->{testcases} } ) { + is quality( $type, $accept ), $quality, $type; + } +} diff --git a/t/04-best_match.t b/t/04-best_match.t new file mode 100644 index 0000000..ea12e65 --- /dev/null +++ b/t/04-best_match.t @@ -0,0 +1,23 @@ +#!/usr/bin/perl +use strict; +use warnings; + +use Test::More; +use Parse::MIME 'best_match'; + +use lib 't/lib'; +use TestParseMIME; +my $testcase = TestParseMIME::load_data $0; + +use constant { RANGE => 0, RESULT => 1, DESC => 2 }; + +use List::Util 'sum'; +plan tests => 0 + sum map { 0 + @{ $_->{testcases} } } @$testcase; + +for my $group ( @$testcase ) { + my $mime_types_supported = $group->{ supported }; + + for my $case ( @{ $group->{ testcases } } ) { + is best_match( $mime_types_supported, $case->[ RANGE ] ), $case->[ RESULT ], $case->[ DESC ]; + } +} diff --git a/t/lib/TestParseMIME.pm b/t/lib/TestParseMIME.pm new file mode 100644 index 0000000..d88a6f4 --- /dev/null +++ b/t/lib/TestParseMIME.pm @@ -0,0 +1,27 @@ +#!/usr/bin/perl +use strict; +use warnings; + +package # hide from PAUSE + TestParseMIME; + +use File::Basename 'fileparse'; +use JSON::XS 'decode_json'; + +sub load_data { + my ( $filename ) = @_; + + my $testdata = decode_json do { + my ( undef, $path ) = fileparse __FILE__, qr/\.pm\z/; + open my $fh, '<', $path . 'fixtures.json' + or die "Can't read test fixtures: $!\n"; + local $/; + <$fh>; + }; + + my ( $key ) = fileparse $filename, qr/\.t\z/; + $key =~ s/\A[0-9]+\-//; + return $testdata->{ $key }; +} + +1; diff --git a/t/lib/fixtures.json b/t/lib/fixtures.json new file mode 100644 index 0000000..6cd1744 --- /dev/null +++ b/t/lib/fixtures.json @@ -0,0 +1,70 @@ +{ +"parse_mime_type": { + "application/xhtml;q=0.5": ["application", "xhtml", {"q": "0.5"}], + "application/xhtml;q=0.5;ver=1.2": ["application", "xhtml", {"q": "0.5", "ver": "1.2"}] +}, + +"parse_media_range": { + "application/xml;q=1" : [ "application", "xml", { "q": "1" } ], + "application/xml" : [ "application", "xml", { "q": "1" } ], + "application/xml;q=" : [ "application", "xml", { "q": "1" } ], + "application/xml ; q=" : [ "application", "xml", { "q": "1" } ], + "application/xml ; q=1;b=other" : [ "application", "xml", { "q": "1", "b": "other" } ], + "application/xml ; q=2;b=other" : [ "application", "xml", { "q": "1", "b": "other" } ], + " *; q=.2": [ "*", "*", { "q": ".2" } ] +}, + +"quality": [ + { + "accept": "text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5", + "testcases": { + "text/html;level=1" : 1.0, + "text/html" : 0.7, + "text/plain" : 0.3, + "image/jpeg" : 0.5, + "text/html;level=2" : 0.4, + "text/html;level=3" : 0.7 + } + }, + { + "accept": "text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2", + "testcases": { + "text/plain" : 0.2 + } + } +], + +"best_match": [ + { + "supported": [ "application/xbel+xml", "application/xml" ], + "testcases": [ + [ "application/xbel+xml", "application/xbel+xml", "direct match" ], + [ "application/xbel+xml; q=1", "application/xbel+xml", "direct match with a q parameter" ], + [ "application/xml; q=1", "application/xml", "direct match of our second choice with a q parameter" ], + [ "application/*; q=1", "application/xml", "match using a subtype wildcard" ], + [ "*/*", "application/xml", "match using a type wildcard" ] + ] + }, + { + "supported": [ "application/xbel+xml", "text/xml" ], + "testcases": [ + [ "text/*;q=0.5,*/*; q=0.1", "text/xml", "match using a type versus a lower weighted subtype" ], + [ "text/html,application/atom+xml; q=0.9", null, "fail to match anything" ] + ] + }, + { + "supported": [ "application/json", "text/html" ], + "testcases": [ + [ "application/json, text/javascript, */*", "application/json", "common AJAX scenario" ], + [ "application/json, text/html;q=0.9", "application/json", "verify fitness ordering" ] + ] + }, + { + "supported": [ "image/*", "application/xml" ], + "testcases": [ + [ "image/png", "image/*", "match using a type wildcard" ], + [ "image/*", "image/*", "match using a wildcard for both requested and supported " ] + ] + } +] +} |