/[dtapublic]/projs/dtats/trunk/projs/20161008_web_page_thumbnail_make/pics_filenames_canonize.php
ViewVC logotype

Diff of /projs/dtats/trunk/projs/20161008_web_page_thumbnail_make/pics_filenames_canonize.php

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

swprojs/trunk/projs/20161018_web_page_thumbnail_make/filenames_canonize.php revision 34 by dashley, Sat Oct 8 21:51:35 2016 UTC projs/dtats/trunk/projs/20161008_web_page_thumbnail_make/pics_filenames_canonize.php revision 115 by dashley, Sun Jan 1 02:24:49 2017 UTC
# Line 1  Line 1 
1  <?php  <?php
2  //--------------------------------------------------------------------------------  //-------------------------------------------------------------------------------------------------
3  //filenames_pics_canonize.php, v0.1a, Copyright David T. Ashley, 2016  //$Header$
4  //--------------------------------------------------------------------------------  //-------------------------------------------------------------------------------------------------
5  //-------------------------------------------------------------------------------------------------  //This source code and any program in which it is compiled/used is provided under the MIT
6  //Copyright 2016 David T. Ashley  //LICENSE (full license text below).
7  //-------------------------------------------------------------------------------------------------  //-------------------------------------------------------------------------------------------------
8  //This source code and any program in which it is compiled/used is provided under the GNU GENERAL  //pics_filenames_canonize.php, Copyright (c) 2016 David T. Ashley
9  //PUBLIC LICENSE, Version 3, full license text below.  //
10  //-------------------------------------------------------------------------------------------------  //Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
11  //                    GNU GENERAL PUBLIC LICENSE  //associated documentation files (the "Software"), to deal in the Software without restriction,
12  //                       Version 3, 29 June 2007  //including without limitation the rights to use, copy, modify, merge, publish, distribute,
13  //  //sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
14  // Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>  //furnished to do so, subject to the following conditions:
15  // Everyone is permitted to copy and distribute verbatim copies  //
16  // of this license document, but changing it is not allowed.  //The above copyright notice and this permission notice shall be included in all copies or
17  //  //substantial portions of the Software.
18  //                            Preamble  //
19  //  //THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
20  //  The GNU General Public License is a free, copyleft license for  //NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21  //software and other kinds of works.  //NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
22  //  //DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  //  The licenses for most software and other practical works are designed  //OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24  //to take away your freedom to share and change the works.  By contrast,  //-------------------------------------------------------------------------------------------------
25  //the GNU General Public License is intended to guarantee your freedom to  //This program, a PHP script, modifies all filenames in a directory to a canonical form (no
26  //share and change all versions of a program--to make sure it remains free  //upper-case letters or unusual characters).  This program is part of a 3-program suite designed to
27  //software for all its users.  We, the Free Software Foundation, use the  //collectively create a web page directly from digital camera files (and of course the web page can
28  //GNU General Public License for most of our software; it applies also to  //be customized by hand-editing after it is automatically generated).
29  //any other work released this way by its authors.  You can apply it to  //
30  //your programs, too.  //The 3 programs in the 3-program suite are:
31  //  //
32  //  When we speak of free software, we are referring to freedom, not  //   pics_filenames_canonize.php (this script):
33  //price.  Our General Public Licenses are designed to make sure that you  //      Converts all names of files in a directory to lower-case, and makes substitutions for any
34  //have the freedom to distribute copies of free software (and charge for  //      unusual characters.
35  //them if you wish), that you receive source code or can get it if you  //
36  //want it, that you can change the software or use pieces of it in new  //   pics_thumbnails_make.php:
37  //free programs, and that you know you can do these things.  //      Creates thumbnails from recognized image types.  The thumbnails are named relative to the
38  //  //      original image file with the suffix "_small".  To support shared hosting environments where
39  //  To protect your rights, we need to prevent others from denying you  //      CPU utilization of a script may be capped, there is a configuration constant in the script
40  //these rights or asking you to surrender the rights.  Therefore, you have  //      that will perform only a fixed number of conversions per invocation.  If this configuration
41  //certain responsibilities if you distribute copies of the software, or if  //      option is used, the script should be run repeatedly until it indicates that it has no more
42  //you modify it: responsibilities to respect the freedom of others.  //      thumbnails to create.
43  //  //
44  //  For example, if you distribute copies of such a program, whether  //      If any full-sized photos are modified, any corresponding thumbnails should be deleted and
45  //gratis or for a fee, you must pass on to the recipients the same  //      pics_thumbnails_make.php and pics_indexfile_make.php should be run again.
46  //freedoms that you received.  You must make sure that they, too, receive  //
47  //or can get the source code.  And you must show them these terms so they  //   pics_indexfile_make.php
48  //know their rights.  //      Scans a directory and makes an index file ("index2.php") displaying all the thumbnail
49  //  //      images, each of which link to the corresponding full-sized image.  The index file is
50  //  Developers that use the GNU GPL protect your rights with two steps:  //      tailored to Dave Ashley's needs, but the created file can be edited and most of the
51  //(1) assert copyright on the software, and (2) offer you this License  //      content pasted into an HTML file.  To avoid the accidental loss of information, any
52  //giving you legal permission to copy, distribute and/or modify it.  //      existing "index2.php" file is renamed out of the way.
53  //  //
54  //  For the developers' and authors' protection, the GPL clearly explains  //This script is designed to be run manually (rather than automatically invoked as a result of a
55  //that there is no warranty for this free software.  For both users' and  //web page request).  It was written in PHP for convenience simply because DreamHost (the web
56  //authors' sake, the GPL requires that modified versions be marked as  //hosting company Dave Ashley used at the time these scripts were written) has as part of its
57  //changed, so that their problems will not be attributed erroneously to  //hosting environment PHP with the ImageMagick library compiled in.
58  //authors of previous versions.  //
59  //  //Usually, this script is invoked using "php <path>/pics_filenames_canonize.php", but the method of
60  //  Some devices are designed to deny users access to install or run  //invocation may vary based on computing platform details.
61  //modified versions of the software inside them, although the manufacturer  //-------------------------------------------------------------------------------------------------
62  //can do so.  This is fundamentally incompatible with the aim of  //C O N F I G U R A T I O N
63  //protecting users' freedom to change the software.  The systematic  //--------------------------------------------------------------------------------
64  //pattern of such abuse occurs in the area of products for individuals to  //Configuration switch combinations were not tested.  E-mail me any program
65  //use, which is precisely where it is most unacceptable.  Therefore, we  //corrections (dashley@gmail.com).
66  //have designed this version of the GPL to prohibit the practice for those  define ("CFG_PROGNAME", "pics_filenames_canonize.php");
67  //products.  If such problems arise substantially in other domains, we     //Number of characters per line preferred for console output.
68  //stand ready to extend this provision to those domains in future versions  define ("CFG_CONSOLE_STD_LINE_LEN", 78);
69  //of the GPL, as needed to protect the freedom of users.     //Number of characters per line preferred for console output.
70  //  define (
71  //  Finally, every program is threatened constantly by software patents.     "CFG_FILENAME_SUBSTITUTION_MAP",
72  //States should not allow patents to restrict development and use of     ".."                                                    //Dots unchanged.
73  //software on general-purpose computers, but in those that do, we wish to     .
74  //avoid the special danger that patents applied to a free program could     "aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz"  //LC letters unchanged.
75  //make it effectively proprietary.  To prevent this, the GPL assures that     .
76  //patents cannot be used to render the program non-free.     "AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz"  //UC converted to LC.
77  //     .
78  //  The precise terms and conditions for copying, distribution and     "00112233445566778899"                                  //Digits unchanged.
79  //modification follow.     .
80  //     "-_"                                                    //Hyphens become underscores,
81  //                       TERMS AND CONDITIONS                                                             //and anything unmapped
82  //                                                             //becomes an underscore.
83  //  0. Definitions.     );
84  //     //Pairs of characters, the first is the character to match and the second
85  //  "This License" refers to version 3 of the GNU General Public License.     //is the replacement.  Any characters not found in the map will be replaced
86  //     //by the last character of the constant.
87  //  "Copyright" also means copyright-like laws that apply to other kinds of  //--------------------------------------------------------------------------------
88  //works, such as semiconductor masks.  //Repeats a character $c to the console output $n times.
89  //  function rep_char_con($c, $n)
90  //  "The Program" refers to any copyrightable work licensed under this  {
91  //License.  Each licensee is addressed as "you".  "Licensees" and     while ($n--)
92  //"recipients" may be individuals or organizations.        echo $c;
93  //  }
94  //  To "modify" a work means to copy from or adapt all or part of the work  //--------------------------------------------------------------------------------
95  //in a fashion requiring copyright permission, other than the making of an  //Writes a standard thick horizontal line to the console.
96  //exact copy.  The resulting work is called a "modified version" of the  function hor_line_thick()
97  //earlier work or a work "based on" the earlier work.  {
98  //     rep_char_con("=", CFG_CONSOLE_STD_LINE_LEN);
99  //  A "covered work" means either the unmodified Program or a work based     echo "\n";
100  //on the Program.  }
101  //  //--------------------------------------------------------------------------------
102  //  To "propagate" a work means to do anything with it that, without  //Writes a standard thin horizontal line to the console.
103  //permission, would make you directly or secondarily liable for  function hor_line_thin()
104  //infringement under applicable copyright law, except executing it on a  {
105  //computer or modifying a private copy.  Propagation includes copying,     rep_char_con("-", CFG_CONSOLE_STD_LINE_LEN);
106  //distribution (with or without modification), making available to the     echo "\n";
107  //public, and in some countries other activities as well.  }
108  //  //--------------------------------------------------------------------------------
109  //  To "convey" a work means any kind of propagation that enables other  //Returns an array of all files in the working directory.
110  //parties to make or receive copies.  Mere interaction with a user through  //If no files can be found, returns FALSE.
111  //a computer network, with no transfer of a copy, is not conveying.  function get_file_names_in_dir()
112  //  {
113  //  An interactive user interface displays "Appropriate Legal Notices"     //Get directory list.
114  //to the extent that it includes a convenient and prominently visible     $rv = scandir (".");
115  //feature that (1) displays an appropriate copyright notice, and (2)  
116  //tells the user that there is no warranty for the work (except to the     //If the list is empty, something went wrong.  Return FALSE.
117  //extent that warranties are provided), that licensees may convey the     if ($rv === FALSE)
118  //work under this License, and how to view a copy of this License.  If        return FALSE;
119  //the interface presents a list of user commands or options, such as a  
120  //menu, a prominent item in the list meets this criterion.     return $rv;
121  //  }
122  //  1. Source Code.  //--------------------------------------------------------------------------------
123  //  //Canonizes a filename by performing character substitutions.
124  //  The "source code" for a work means the preferred form of the work  function canonize($in_fname)
125  //for making modifications to it.  "Object code" means any non-source  {
126  //form of a work.     //Well, the algorithm below is O(N^2) or worse ... I knew there was a reason
127  //     //that computers get faster every year.  (Yes, that was a joke.)
128  //  A "Standard Interface" means an interface that either is an official     $out_fname = "";
129  //standard defined by a recognized standards body, or, in the case of  
130  //interfaces specified for a particular programming language, one that     for ($i = 0; $i < strlen($in_fname); $i++)
131  //is widely used among developers working in that language.     {
132  //        $map = CFG_FILENAME_SUBSTITUTION_MAP;
133  //  The "System Libraries" of an executable work include anything, other        $c = substr($in_fname, $i, 1);
134  //than the work as a whole, that (a) is included in the normal form of  
135  //packaging a Major Component, but which is not part of that Major        $sub_made = FALSE;
136  //Component, and (b) serves only to enable use of the work with that        while (strlen($map) >= 2)
137  //Major Component, or to implement a Standard Interface for which an        {
138  //implementation is available to the public in source code form.  A           if (substr($map, 0, 1) == $c)
139  //"Major Component", in this context, means a major essential component           {
140  //(kernel, window system, and so on) of the specific operating system              $c = substr($map, 1, 1);
141  //(if any) on which the executable work runs, or a compiler used to              $sub_made = TRUE;
142  //produce the work, or an object code interpreter used to run it.              break;
143  //           }
144  //  The "Corresponding Source" for a work in object code form means all           else
145  //the source code needed to generate, install, and (for an executable           {
146  //work) run the object code and to modify the work, including scripts to              $map = substr($map, 2);
147  //control those activities.  However, it does not include the work's           }
148  //System Libraries, or general-purpose tools or generally available free        }
149  //programs which are used unmodified in performing those activities but  
150  //which are not part of the work.  For example, Corresponding Source        if (! $sub_made)
151  //includes interface definition files associated with source files for        {
152  //the work, and the source code for shared libraries and dynamically           $c = substr(CFG_FILENAME_SUBSTITUTION_MAP, strlen(CFG_FILENAME_SUBSTITUTION_MAP) - 1, 1);
153  //linked subprograms that the work is specifically designed to require,           //echo "Default sub made: " . $c . "\n";
154  //such as by intimate data communication or control flow between those        }
155  //subprograms and other parts of the work.  
156  //        $out_fname = $out_fname . $c;
157  //  The Corresponding Source need not include anything that users     }
158  //can regenerate automatically from other parts of the Corresponding  
159  //Source.     return $out_fname;
160  //  }
161  //  The Corresponding Source for a work in source code form is that  //--------------------------------------------------------------------------------
162  //same work.     //Write introductory message.
163  //     hor_line_thick();
164  //  2. Basic Permissions.     echo CFG_PROGNAME . ", Copyright (c) 2016 David T. Ashley\n";
165  //     echo "This program comes with ABSOLUTELY NO WARRANTY; and is licensed under the\n";
166  //  All rights granted under this License are granted for the term of     echo "MIT License.  A copy of this license is provided in the source code\n";
167  //copyright on the Program, and are irrevocable provided the stated     echo "of this program.\n";
168  //conditions are met.  This License explicitly affirms your unlimited     hor_line_thin();
169  //permission to run the unmodified Program.  The output from running a     //-----------------------------------------------------------------------------
170  //covered work is covered by this License only if the output, given its     //Get and emit the names of everything in the directory.
171  //content, constitutes a covered work.  This License acknowledges your     $file_list = get_file_names_in_dir();
172  //rights of fair use or other equivalent, as provided by copyright law.     if ($file_list === FALSE)
173  //     {
174  //  You may make, run and propagate covered works that you do not        echo "List of files from PHP function scandir() is empty (rv === FALSE).\n";
175  //convey, without conditions so long as your license otherwise remains        echo "Serious internal error, or nothing to do.  Script cannot continue.\n";
176  //in force.  You may convey covered works to others for the sole purpose        hor_line_thick();
177  //of having them make modifications exclusively for you, or provide you        exit(1);
178  //with facilities for running those works, provided that you comply with     }
179  //the terms of this License in conveying all material for which you do     else
180  //not control copyright.  Those thus making or running the covered works     {
181  //for you must do so exclusively on your behalf, under your direction       echo "Files in working directory (unsorted, unfiltered, "
182  //and control, on terms that prohibit them from making any copies of            .
183  //your copyrighted material outside their relationship with you.            count($file_list)
184  //            .
185  //  Conveying under any other circumstances is permitted solely under            " files):\n";
186  //the conditions stated below.  Sublicensing is not allowed; section 10       for ($i = 0; $i < count($file_list); $i++)
187  //makes it unnecessary.          echo "   " . sprintf("[%5d]", $i) . " " . $file_list[$i] . "\n";
188  //     }
189  //  3. Protecting Users' Legal Rights From Anti-Circumvention Law.     hor_line_thin();
190  //     //-----------------------------------------------------------------------------
191  //  No covered work shall be deemed part of an effective technological     //Remove everything that is not a file we can rename.
192  //measure under any applicable law fulfilling obligations under article     $temp_list = $file_list;
193  //11 of the WIPO copyright treaty adopted on 20 December 1996, or     unset($file_list);
194  //similar laws prohibiting or restricting circumvention of such     $n = 0;
195  //measures.     for ($i = 0; $i < count($temp_list); $i++)
196  //     {
197  //  When you convey a covered work, you waive any legal power to forbid        //echo "Checking " . $temp_list[$i] . "\n";
198  //circumvention of technological measures to the extent such circumvention  
199  //is effected by exercising rights under this License with respect to        if (strcmp($temp_list[$i], ".") == 0)
200  //the covered work, and you disclaim any intention to limit operation or        {
201  //modification of the work as a means of enforcing, against the work's           //. entry, not a file.
202  //users, your or third parties' legal rights to forbid circumvention of        }
203  //technological measures.        else if (strcmp($temp_list[$i], "..") == 0)
204  //        {
205  //  4. Conveying Verbatim Copies.           //.. entry, not a file.
206  //        }
207  //  You may convey verbatim copies of the Program's source code as you        else if (is_file($temp_list[$i]))
208  //receive it, in any medium, provided that you conspicuously and        {
209  //appropriately publish on each copy an appropriate copyright notice;           //This is a regular file.
210  //keep intact all notices stating that this License and any           $file_list[] = $temp_list[$i];
211  //non-permissive terms added in accord with section 7 apply to the code;           $n++;
212  //keep intact all notices of the absence of any warranty; and give all        }
213  //recipients a copy of this License along with the Program.     }
214  //    
215  //  You may charge any price or no price for each copy that you convey,     if ($n == 0)
216  //and you may offer support or warranty protection for a fee.        $file_list = FALSE;
217  //  
218  //  5. Conveying Modified Source Versions.     unset($n);
219  //     unset($temp_list);
220  //  You may convey a work based on the Program, or the modifications to     //-----------------------------------------------------------------------------
221  //produce it from the Program, in the form of source code under the     //If there is nothing to do, end the script.
222  //terms of section 4, provided that you also meet all of these conditions:     if ($file_list === FALSE)
223  //     {
224  //    a) The work must carry prominent notices stating that you modified        echo "No files to rename.\n";
225  //    it, and giving a relevant date.        hor_line_thick();
226  //        exit(0);
227  //    b) The work must carry prominent notices stating that it is     }
228  //    released under this License and any conditions added under section     //-----------------------------------------------------------------------------
229  //    7.  This requirement modifies the requirement in section 4 to     //Sort the list.  This is a non-event.  The only rationale for sorting is that
230  //    "keep intact all notices".     //it ensures that the same set of files will be processed in the same order,
231  //     //regardless of the order provided by the underlying OS internals.
232  //    c) You must license the entire work, as a whole, under this     sort($file_list);
233  //    License to anyone who comes into possession of a copy.  This     //-----------------------------------------------------------------------------
234  //    License will therefore apply, along with any applicable section 7     //Emit the names we now have.
235  //    additional terms, to the whole of the work, and all its parts,     echo "Files in working directory (directory entries removed, sorted, "
236  //    regardless of how they are packaged.  This License gives no          .
237  //    permission to license the work in any other way, but it does not          count($file_list)
238  //    invalidate such permission if you have separately received it.          .
239  //          " files):\n";
240  //    d) If the work has interactive user interfaces, each must display     for ($i = 0; $i < count($file_list); $i++)
241  //    Appropriate Legal Notices; however, if the Program has interactive        echo "   " . sprintf("[%5d]", $i) . " " . $file_list[$i] . "\n";
242  //    interfaces that do not display Appropriate Legal Notices, your     hor_line_thin();
243  //    work need not make them do so.     //-----------------------------------------------------------------------------
244  //     //For each file in the directory, form a filename which would be the result
245  //  A compilation of a covered work with other separate and independent     //of applying character substitutions and any other corrections.
246  //works, which are not by their nature extensions of the covered work,     for ($i = 0; $i < count($file_list); $i++)
247  //and which are not combined with it such as to form a larger program,     {
248  //in or on a volume of a storage or distribution medium, is called an        $rename_target[$i] = canonize($file_list[$i]);
249  //"aggregate" if the compilation and its resulting copyright are not  
250  //used to limit the access or legal rights of the compilation's users        //echo $file_list[$i] . " " . $rename_target[$i] . "\n";
251  //beyond what the individual works permit.  Inclusion of a covered work     }
252  //in an aggregate does not cause this License to apply to the other     //-----------------------------------------------------------------------------
253  //parts of the aggregate.     //In all those cases where the name of the file as we would like it to be is
254  //     //different from the name of the file as it exists, rename it.  Watch for
255  //  6. Conveying Non-Source Forms.     //collisions, because renaming on top of a file represents the loss of
256  //     //data.
257  //  You may convey a covered work in object code form under the terms     $n = 0;
258  //of sections 4 and 5, provided that you also convey the     for ($i = 0; $i < count($file_list); $i++)
259  //machine-readable Corresponding Source under the terms of this License,     {
260  //in one of these ways:        if (strcmp($file_list[$i], $rename_target[$i]) != 0)
261  //           $n++;
262  //    a) Convey the object code in, or embodied in, a physical product     }
263  //    (including a physical distribution medium), accompanied by the  
264  //    Corresponding Source fixed on a durable physical medium     if ($n == 0)
265  //    customarily used for software interchange.     {
266  //        echo "No files need to be renamed.\n";
267  //    b) Convey the object code in, or embodied in, a physical product        hor_line_thin();
268  //    (including a physical distribution medium), accompanied by a     }
269  //    written offer, valid for at least three years and valid for as     else
270  //    long as you offer spare parts or customer support for that product     {
271  //    model, to give anyone who possesses the object code either (1) a        echo "Renaming " . $n . " file(s).\n";
272  //    copy of the Corresponding Source for all the software in the        hor_line_thin();
273  //    product that is covered by this License, on a durable physical  
274  //    medium customarily used for software interchange, for a price no        $count = 0;
275  //    more than your reasonable cost of physically performing this        for ($i = 0; $i < count($file_list); $i++)
276  //    conveying of source, or (2) access to copy the        {
277  //    Corresponding Source from a network server at no charge.           if (strcmp($file_list[$i], $rename_target[$i]) != 0)
278  //           {
279  //    c) Convey individual copies of the object code with a copy of the              $count++;
280  //    written offer to provide the Corresponding Source.  This              echo "[" . sprintf("%5d/%5d", $count, $n) . "]"
281  //    alternative is allowed only occasionally and noncommercially, and                   .
282  //    only if you received the object code with such an offer, in accord                   " Renaming " . $file_list[$i] . " to " . $rename_target[$i] . " ... ";
283  //    with subsection 6b.              if (file_exists($rename_target[$i]))
284  //              {
285  //    d) Convey the object code by offering access from a designated                 echo "Aborted.\nRename target already exists.\n";
286  //    place (gratis or for a charge), and offer equivalent access to the                 echo "Choose non-colliding filenames and run this script again.\n";
287  //    Corresponding Source in the same way through the same place at no                 echo "Script terminating.\n";
288  //    further charge.  You need not require recipients to copy the                 hor_line_thin();
289  //    Corresponding Source along with the object code.  If the place to                 exit(1);
290  //    copy the object code is a network server, the Corresponding Source              }
291  //    may be on a different server (operated by you or a third party)  
292  //    that supports equivalent copying facilities, provided you maintain              $result = rename($file_list[$i], $rename_target[$i]);
293  //    clear directions next to the object code saying where to find the              if ($result)
294  //    Corresponding Source.  Regardless of what server hosts the              {
295  //    Corresponding Source, you remain obligated to ensure that it is                 echo "Done.\n";
296  //    available for as long as needed to satisfy these requirements.                 hor_line_thin();
297  //              }
298  //    e) Convey the object code using peer-to-peer transmission, provided              else
299  //    you inform other peers where the object code and Corresponding              {
300  //    Source of the work are being offered to the general public at no                 echo "Failed.\nScript must terminate.\n";
301  //    charge under subsection 6d.                 hor_line_thick();
302  //                 exit(1);
303  //  A separable portion of the object code, whose source code is excluded              }
304  //from the Corresponding Source as a System Library, need not be           }
305  //included in conveying the object code work.        }
306  //     }
307  //  A "User Product" is either (1) a "consumer product", which means any     //-----------------------------------------------------------------------------
308  //tangible personal property which is normally used for personal, family,     echo CFG_PROGNAME . " execution ends.\n";
309  //or household purposes, or (2) anything designed or sold for incorporation     hor_line_thick();
310  //into a dwelling.  In determining whether a product is a consumer product,  //--------------------------------------------------------------------------------
311  //doubtful cases shall be resolved in favor of coverage.  For a particular  //End of File
312  //product received by a particular user, "normally used" refers to a  //--------------------------------------------------------------------------------
313  //typical or common use of that class of product, regardless of the status  ?>
 //of the particular user or of the way in which the particular user  
 //actually uses, or expects or is expected to use, the product.  A product  
 //is a consumer product regardless of whether the product has substantial  
 //commercial, industrial or non-consumer uses, unless such uses represent  
 //the only significant mode of use of the product.  
 //  
 //  "Installation Information" for a User Product means any methods,  
 //procedures, authorization keys, or other information required to install  
 //and execute modified versions of a covered work in that User Product from  
 //a modified version of its Corresponding Source.  The information must  
 //suffice to ensure that the continued functioning of the modified object  
 //code is in no case prevented or interfered with solely because  
 //modification has been made.  
 //  
 //  If you convey an object code work under this section in, or with, or  
 //specifically for use in, a User Product, and the conveying occurs as  
 //part of a transaction in which the right of possession and use of the  
 //User Product is transferred to the recipient in perpetuity or for a  
 //fixed term (regardless of how the transaction is characterized), the  
 //Corresponding Source conveyed under this section must be accompanied  
 //by the Installation Information.  But this requirement does not apply  
 //if neither you nor any third party retains the ability to install  
 //modified object code on the User Product (for example, the work has  
 //been installed in ROM).  
 //  
 //  The requirement to provide Installation Information does not include a  
 //requirement to continue to provide support service, warranty, or updates  
 //for a work that has been modified or installed by the recipient, or for  
 //the User Product in which it has been modified or installed.  Access to a  
 //network may be denied when the modification itself materially and  
 //adversely affects the operation of the network or violates the rules and  
 //protocols for communication across the network.  
 //  
 //  Corresponding Source conveyed, and Installation Information provided,  
 //in accord with this section must be in a format that is publicly  
 //documented (and with an implementation available to the public in  
 //source code form), and must require no special password or key for  
 //unpacking, reading or copying.  
 //  
 //  7. Additional Terms.  
 //  
 //  "Additional permissions" are terms that supplement the terms of this  
 //License by making exceptions from one or more of its conditions.  
 //Additional permissions that are applicable to the entire Program shall  
 //be treated as though they were included in this License, to the extent  
 //that they are valid under applicable law.  If additional permissions  
 //apply only to part of the Program, that part may be used separately  
 //under those permissions, but the entire Program remains governed by  
 //this License without regard to the additional permissions.  
 //  
 //  When you convey a copy of a covered work, you may at your option  
 //remove any additional permissions from that copy, or from any part of  
 //it.  (Additional permissions may be written to require their own  
 //removal in certain cases when you modify the work.)  You may place  
 //additional permissions on material, added by you to a covered work,  
 //for which you have or can give appropriate copyright permission.  
 //  
 //  Notwithstanding any other provision of this License, for material you  
 //add to a covered work, you may (if authorized by the copyright holders of  
 //that material) supplement the terms of this License with terms:  
 //  
 //    a) Disclaiming warranty or limiting liability differently from the  
 //    terms of sections 15 and 16 of this License; or  
 //  
 //    b) Requiring preservation of specified reasonable legal notices or  
 //    author attributions in that material or in the Appropriate Legal  
 //    Notices displayed by works containing it; or  
 //  
 //    c) Prohibiting misrepresentation of the origin of that material, or  
 //    requiring that modified versions of such material be marked in  
 //    reasonable ways as different from the original version; or  
 //  
 //    d) Limiting the use for publicity purposes of names of licensors or  
 //    authors of the material; or  
 //  
 //    e) Declining to grant rights under trademark law for use of some  
 //    trade names, trademarks, or service marks; or  
 //  
 //    f) Requiring indemnification of licensors and authors of that  
 //    material by anyone who conveys the material (or modified versions of  
 //    it) with contractual assumptions of liability to the recipient, for  
 //    any liability that these contractual assumptions directly impose on  
 //    those licensors and authors.  
 //  
 //  All other non-permissive additional terms are considered "further  
 //restrictions" within the meaning of section 10.  If the Program as you  
 //received it, or any part of it, contains a notice stating that it is  
 //governed by this License along with a term that is a further  
 //restriction, you may remove that term.  If a license document contains  
 //a further restriction but permits relicensing or conveying under this  
 //License, you may add to a covered work material governed by the terms  
 //of that license document, provided that the further restriction does  
 //not survive such relicensing or conveying.  
 //  
 //  If you add terms to a covered work in accord with this section, you  
 //must place, in the relevant source files, a statement of the  
 //additional terms that apply to those files, or a notice indicating  
 //where to find the applicable terms.  
 //  
 //  Additional terms, permissive or non-permissive, may be stated in the  
 //form of a separately written license, or stated as exceptions;  
 //the above requirements apply either way.  
 //  
 //  8. Termination.  
 //  
 //  You may not propagate or modify a covered work except as expressly  
 //provided under this License.  Any attempt otherwise to propagate or  
 //modify it is void, and will automatically terminate your rights under  
 //this License (including any patent licenses granted under the third  
 //paragraph of section 11).  
 //  
 //  However, if you cease all violation of this License, then your  
 //license from a particular copyright holder is reinstated (a)  
 //provisionally, unless and until the copyright holder explicitly and  
 //finally terminates your license, and (b) permanently, if the copyright  
 //holder fails to notify you of the violation by some reasonable means  
 //prior to 60 days after the cessation.  
 //  
 //  Moreover, your license from a particular copyright holder is  
 //reinstated permanently if the copyright holder notifies you of the  
 //violation by some reasonable means, this is the first time you have  
 //received notice of violation of this License (for any work) from that  
 //copyright holder, and you cure the violation prior to 30 days after  
 //your receipt of the notice.  
 //  
 //  Termination of your rights under this section does not terminate the  
 //licenses of parties who have received copies or rights from you under  
 //this License.  If your rights have been terminated and not permanently  
 //reinstated, you do not qualify to receive new licenses for the same  
 //material under section 10.  
 //  
 //  9. Acceptance Not Required for Having Copies.  
 //  
 //  You are not required to accept this License in order to receive or  
 //run a copy of the Program.  Ancillary propagation of a covered work  
 //occurring solely as a consequence of using peer-to-peer transmission  
 //to receive a copy likewise does not require acceptance.  However,  
 //nothing other than this License grants you permission to propagate or  
 //modify any covered work.  These actions infringe copyright if you do  
 //not accept this License.  Therefore, by modifying or propagating a  
 //covered work, you indicate your acceptance of this License to do so.  
 //  
 //  10. Automatic Licensing of Downstream Recipients.  
 //  
 //  Each time you convey a covered work, the recipient automatically  
 //receives a license from the original licensors, to run, modify and  
 //propagate that work, subject to this License.  You are not responsible  
 //for enforcing compliance by third parties with this License.  
 //  
 //  An "entity transaction" is a transaction transferring control of an  
 //organization, or substantially all assets of one, or subdividing an  
 //organization, or merging organizations.  If propagation of a covered  
 //work results from an entity transaction, each party to that  
 //transaction who receives a copy of the work also receives whatever  
 //licenses to the work the party's predecessor in interest had or could  
 //give under the previous paragraph, plus a right to possession of the  
 //Corresponding Source of the work from the predecessor in interest, if  
 //the predecessor has it or can get it with reasonable efforts.  
 //  
 //  You may not impose any further restrictions on the exercise of the  
 //rights granted or affirmed under this License.  For example, you may  
 //not impose a license fee, royalty, or other charge for exercise of  
 //rights granted under this License, and you may not initiate litigation  
 //(including a cross-claim or counterclaim in a lawsuit) alleging that  
 //any patent claim is infringed by making, using, selling, offering for  
 //sale, or importing the Program or any portion of it.  
 //  
 //  11. Patents.  
 //  
 //  A "contributor" is a copyright holder who authorizes use under this  
 //License of the Program or a work on which the Program is based.  The  
 //work thus licensed is called the contributor's "contributor version".  
 //  
 //  A contributor's "essential patent claims" are all patent claims  
 //owned or controlled by the contributor, whether already acquired or  
 //hereafter acquired, that would be infringed by some manner, permitted  
 //by this License, of making, using, or selling its contributor version,  
 //but do not include claims that would be infringed only as a  
 //consequence of further modification of the contributor version.  For  
 //purposes of this definition, "control" includes the right to grant  
 //patent sublicenses in a manner consistent with the requirements of  
 //this License.  
 //  
 //  Each contributor grants you a non-exclusive, worldwide, royalty-free  
 //patent license under the contributor's essential patent claims, to  
 //make, use, sell, offer for sale, import and otherwise run, modify and  
 //propagate the contents of its contributor version.  
 //  
 //  In the following three paragraphs, a "patent license" is any express  
 //agreement or commitment, however denominated, not to enforce a patent  
 //(such as an express permission to practice a patent or covenant not to  
 //sue for patent infringement).  To "grant" such a patent license to a  
 //party means to make such an agreement or commitment not to enforce a  
 //patent against the party.  
 //  
 //  If you convey a covered work, knowingly relying on a patent license,  
 //and the Corresponding Source of the work is not available for anyone  
 //to copy, free of charge and under the terms of this License, through a  
 //publicly available network server or other readily accessible means,  
 //then you must either (1) cause the Corresponding Source to be so  
 //available, or (2) arrange to deprive yourself of the benefit of the  
 //patent license for this particular work, or (3) arrange, in a manner  
 //consistent with the requirements of this License, to extend the patent  
 //license to downstream recipients.  "Knowingly relying" means you have  
 //actual knowledge that, but for the patent license, your conveying the  
 //covered work in a country, or your recipient's use of the covered work  
 //in a country, would infringe one or more identifiable patents in that  
 //country that you have reason to believe are valid.  
 //  
 //  If, pursuant to or in connection with a single transaction or  
 //arrangement, you convey, or propagate by procuring conveyance of, a  
 //covered work, and grant a patent license to some of the parties  
 //receiving the covered work authorizing them to use, propagate, modify  
 //or convey a specific copy of the covered work, then the patent license  
 //you grant is automatically extended to all recipients of the covered  
 //work and works based on it.  
 //  
 //  A patent license is "discriminatory" if it does not include within  
 //the scope of its coverage, prohibits the exercise of, or is  
 //conditioned on the non-exercise of one or more of the rights that are  
 //specifically granted under this License.  You may not convey a covered  
 //work if you are a party to an arrangement with a third party that is  
 //in the business of distributing software, under which you make payment  
 //to the third party based on the extent of your activity of conveying  
 //the work, and under which the third party grants, to any of the  
 //parties who would receive the covered work from you, a discriminatory  
 //patent license (a) in connection with copies of the covered work  
 //conveyed by you (or copies made from those copies), or (b) primarily  
 //for and in connection with specific products or compilations that  
 //contain the covered work, unless you entered into that arrangement,  
 //or that patent license was granted, prior to 28 March 2007.  
 //  
 //  Nothing in this License shall be construed as excluding or limiting  
 //any implied license or other defenses to infringement that may  
 //otherwise be available to you under applicable patent law.  
 //  
 //  12. No Surrender of Others' Freedom.  
 //  
 //  If conditions are imposed on you (whether by court order, agreement or  
 //otherwise) that contradict the conditions of this License, they do not  
 //excuse you from the conditions of this License.  If you cannot convey a  
 //covered work so as to satisfy simultaneously your obligations under this  
 //License and any other pertinent obligations, then as a consequence you may  
 //not convey it at all.  For example, if you agree to terms that obligate you  
 //to collect a royalty for further conveying from those to whom you convey  
 //the Program, the only way you could satisfy both those terms and this  
 //License would be to refrain entirely from conveying the Program.  
 //  
 //  13. Use with the GNU Affero General Public License.  
 //  
 //  Notwithstanding any other provision of this License, you have  
 //permission to link or combine any covered work with a work licensed  
 //under version 3 of the GNU Affero General Public License into a single  
 //combined work, and to convey the resulting work.  The terms of this  
 //License will continue to apply to the part which is the covered work,  
 //but the special requirements of the GNU Affero General Public License,  
 //section 13, concerning interaction through a network will apply to the  
 //combination as such.  
 //  
 //  14. Revised Versions of this License.  
 //  
 //  The Free Software Foundation may publish revised and/or new versions of  
 //the GNU 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 that a certain numbered version of the GNU General  
 //Public License "or any later version" applies to it, you have the  
 //option of following the terms and conditions either of that numbered  
 //version or of any later version published by the Free Software  
 //Foundation.  If the Program does not specify a version number of the  
 //GNU General Public License, you may choose any version ever published  
 //by the Free Software Foundation.  
 //  
 //  If the Program specifies that a proxy can decide which future  
 //versions of the GNU General Public License can be used, that proxy's  
 //public statement of acceptance of a version permanently authorizes you  
 //to choose that version for the Program.  
 //  
 //  Later license versions may give you additional or different  
 //permissions.  However, no additional obligations are imposed on any  
 //author or copyright holder as a result of your choosing to follow a  
 //later version.  
 //  
 //  15. Disclaimer of Warranty.  
 //  
 //  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.  
 //  
 //  16. Limitation of Liability.  
 //  
 //  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING  
 //WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS  
 //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.  
 //  
 //  17. Interpretation of Sections 15 and 16.  
 //  
 //  If the disclaimer of warranty and limitation of liability provided  
 //above cannot be given local legal effect according to their terms,  
 //reviewing courts shall apply local law that most closely approximates  
 //an absolute waiver of all civil liability in connection with the  
 //Program, unless a warranty or assumption of liability accompanies a  
 //copy of the Program in return for a fee.  
 //  
 //                     END OF TERMS AND CONDITIONS  
 //  
 //            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 the public, 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  
 //state 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) <year>  <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 3 of the License, 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, see <http://www.gnu.org/licenses/>.  
 //  
 //Also add information on how to contact you by electronic and paper mail.  
 //  
 //  If the program does terminal interaction, make it output a short  
 //notice like this when it starts in an interactive mode:  
 //  
 //    <program>  Copyright (C) <year>  <name of author>  
 //    This program 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, your program's commands  
 //might be different; for a GUI interface, you would use an "about box".  
 //  
 //  You should also get your employer (if you work as a programmer) or school,  
 //if any, to sign a "copyright disclaimer" for the program, if necessary.  
 //For more information on this, and how to apply and follow the GNU GPL, see  
 //<http://www.gnu.org/licenses/>.  
 //  
 //  The GNU General Public License does not permit incorporating your program  
 //into proprietary programs.  If your program is a subroutine library, you  
 //may consider it more useful to permit linking proprietary applications with  
 //the library.  If this is what you want to do, use the GNU Lesser General  
 //Public License instead of this License.  But first, please read  
 //<http://www.gnu.org/philosophy/why-not-lgpl.html>.  
 //-------------------------------------------------------------------------------------------------  
 //This program, a PHP script, modifies all filenames in a directory to a canonical  
 //form (no upper-case letters or unusual characters).  This program is part of a  
 //3-program suite designed to collectively create a web page directly from  
 //digital camera files (and of course the web page can be customized by  
 //hand-editing after it is automatically generated).  The supported process for  
 //creating a web page involves 3 programs (rather than 1) primarily to circumvent  
 //the involuntary process termination that will occur in some shared environments  
 //if a process consumes too much CPU time.  
 //  
 //The 3 programs in the 3-program suite are:  
 //  
 //   filenames_canonize.php (this program):  
 //      Converts all names of files in a directory to lower-case, and makes  
 //      substitutions for any unusual characters.  
 //  
 //   thumbnails_make.php:  
 //      Creates thumbnails from recognized image types.  The thumbnails are  
 //      named relative to the original image file with the suffix "_small".  
 //      Only 20 files are converted on each invocation of the program, to  
 //      avoid the involuntary process termination that typically occurs in  
 //      a shared hosting environment when a process uses too much CPU time.  
 //      The program should be run repeatedly until it indicates that it has  
 //      no more thumbnails to create.  
 //  
 //      If any full-sized photos are modified, any corresponding thumbnails  
 //      should be deleted and thumbnails_make.php and indexfile_make.php  
 //      should be run again.  
 //  
 //   indexfile_make.php  
 //      Scans a directory and makes an index file ("index2.php") displaying  
 //      all the thumbnail images, each of which link to the corresponding  
 //      full-sized image.  The index file is tailored to Dave Ashley's  
 //      needs, but the created file can be edited and most of the content  
 //      pasted into an HTML file.  To avoid the accidental loss of  
 //      information, any existing "index2.php" file is renamed out of the  
 //      way.  
 //  
 //This script is designed to be run manually (rather than automatically invoked  
 //as a result of a web page request).  It was written in PHP for convenience  
 //simply because DreamHost (the web hosting company Dave Ashley uses) has as part  
 //of its hosting environment PHP with the ImageMagick library compiled in.  
 //  
 //Usually, this script is invoked using "php <path>/filenames_canonize.php", but  
 //the method of invocation may vary based on computing platform details.  
 //--------------------------------------------------------------------------------  
 //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 3 of the License, 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.  
 //  
 //The GNU General Public License is reproduced below, and also is  
 //available at http://www.gnu.org/licenses/.  
 //--------------------------------------------------------------------------------  
 //                    GNU GENERAL PUBLIC LICENSE  
 //                       Version 3, 29 June 2007  
 //  
 // Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>  
 // Everyone is permitted to copy and distribute verbatim copies  
 // of this license document, but changing it is not allowed.  
 //  
 //                            Preamble  
 //  
 //   The GNU General Public License is a free, copyleft license for  
 // software and other kinds of works.  
 //  
 //   The licenses for most software and other practical works are designed  
 // to take away your freedom to share and change the works.  By contrast,  
 // the GNU General Public License is intended to guarantee your freedom to  
 // share and change all versions of a program--to make sure it remains free  
 // software for all its users.  We, the Free Software Foundation, use the  
 // GNU General Public License for most of our software; it applies also to  
 // any other work released this way by its authors.  You can apply it to  
 // your programs, too.  
 //  
 //   When we speak of free software, we are referring to freedom, not  
 // price.  Our General Public Licenses are designed to make sure that you  
 // have the freedom to distribute copies of free software (and charge for  
 // them if you wish), 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 prevent others from denying you  
 // these rights or asking you to surrender the rights.  Therefore, you have  
 // certain responsibilities if you distribute copies of the software, or if  
 // you modify it: responsibilities to respect the freedom of others.  
 //  
 //   For example, if you distribute copies of such a program, whether  
 // gratis or for a fee, you must pass on to the recipients the same  
 // freedoms that you received.  You must make sure that they, too, receive  
 // or can get the source code.  And you must show them these terms so they  
 // know their rights.  
 //  
 //   Developers that use the GNU GPL protect your rights with two steps:  
 // (1) assert copyright on the software, and (2) offer you this License  
 // giving you legal permission to copy, distribute and/or modify it.  
 //  
 //   For the developers' and authors' protection, the GPL clearly explains  
 // that there is no warranty for this free software.  For both users' and  
 // authors' sake, the GPL requires that modified versions be marked as  
 // changed, so that their problems will not be attributed erroneously to  
 // authors of previous versions.  
 //  
 //   Some devices are designed to deny users access to install or run  
 // modified versions of the software inside them, although the manufacturer  
 // can do so.  This is fundamentally incompatible with the aim of  
 // protecting users' freedom to change the software.  The systematic  
 // pattern of such abuse occurs in the area of products for individuals to  
 // use, which is precisely where it is most unacceptable.  Therefore, we  
 // have designed this version of the GPL to prohibit the practice for those  
 // products.  If such problems arise substantially in other domains, we  
 // stand ready to extend this provision to those domains in future versions  
 // of the GPL, as needed to protect the freedom of users.  
 //  
 //   Finally, every program is threatened constantly by software patents.  
 // States should not allow patents to restrict development and use of  
 // software on general-purpose computers, but in those that do, we wish to  
 // avoid the special danger that patents applied to a free program could  
 // make it effectively proprietary.  To prevent this, the GPL assures that  
 // patents cannot be used to render the program non-free.  
 //  
 //   The precise terms and conditions for copying, distribution and  
 // modification follow.  
 //  
 //                       TERMS AND CONDITIONS  
 //  
 //   0. Definitions.  
 //  
 //   "This License" refers to version 3 of the GNU General Public License.  
 //  
 //   "Copyright" also means copyright-like laws that apply to other kinds of  
 // works, such as semiconductor masks.  
 //  
 //   "The Program" refers to any copyrightable work licensed under this  
 // License.  Each licensee is addressed as "you".  "Licensees" and  
 // "recipients" may be individuals or organizations.  
 //  
 //   To "modify" a work means to copy from or adapt all or part of the work  
 // in a fashion requiring copyright permission, other than the making of an  
 // exact copy.  The resulting work is called a "modified version" of the  
 // earlier work or a work "based on" the earlier work.  
 //  
 //   A "covered work" means either the unmodified Program or a work based  
 // on the Program.  
 //  
 //   To "propagate" a work means to do anything with it that, without  
 // permission, would make you directly or secondarily liable for  
 // infringement under applicable copyright law, except executing it on a  
 // computer or modifying a private copy.  Propagation includes copying,  
 // distribution (with or without modification), making available to the  
 // public, and in some countries other activities as well.  
 //  
 //   To "convey" a work means any kind of propagation that enables other  
 // parties to make or receive copies.  Mere interaction with a user through  
 // a computer network, with no transfer of a copy, is not conveying.  
 //  
 //   An interactive user interface displays "Appropriate Legal Notices"  
 // to the extent that it includes a convenient and prominently visible  
 // feature that (1) displays an appropriate copyright notice, and (2)  
 // tells the user that there is no warranty for the work (except to the  
 // extent that warranties are provided), that licensees may convey the  
 // work under this License, and how to view a copy of this License.  If  
 // the interface presents a list of user commands or options, such as a  
 // menu, a prominent item in the list meets this criterion.  
 //  
 //   1. Source Code.  
 //  
 //   The "source code" for a work means the preferred form of the work  
 // for making modifications to it.  "Object code" means any non-source  
 // form of a work.  
 //  
 //   A "Standard Interface" means an interface that either is an official  
 // standard defined by a recognized standards body, or, in the case of  
 // interfaces specified for a particular programming language, one that  
 // is widely used among developers working in that language.  
 //  
 //   The "System Libraries" of an executable work include anything, other  
 // than the work as a whole, that (a) is included in the normal form of  
 // packaging a Major Component, but which is not part of that Major  
 // Component, and (b) serves only to enable use of the work with that  
 // Major Component, or to implement a Standard Interface for which an  
 // implementation is available to the public in source code form.  A  
 // "Major Component", in this context, means a major essential component  
 // (kernel, window system, and so on) of the specific operating system  
 // (if any) on which the executable work runs, or a compiler used to  
 // produce the work, or an object code interpreter used to run it.  
 //  
 //   The "Corresponding Source" for a work in object code form means all  
 // the source code needed to generate, install, and (for an executable  
 // work) run the object code and to modify the work, including scripts to  
 // control those activities.  However, it does not include the work's  
 // System Libraries, or general-purpose tools or generally available free  
 // programs which are used unmodified in performing those activities but  
 // which are not part of the work.  For example, Corresponding Source  
 // includes interface definition files associated with source files for  
 // the work, and the source code for shared libraries and dynamically  
 // linked subprograms that the work is specifically designed to require,  
 // such as by intimate data communication or control flow between those  
 // subprograms and other parts of the work.  
 //  
 //   The Corresponding Source need not include anything that users  
 // can regenerate automatically from other parts of the Corresponding  
 // Source.  
 //  
 //   The Corresponding Source for a work in source code form is that  
 // same work.  
 //  
 //   2. Basic Permissions.  
 //  
 //   All rights granted under this License are granted for the term of  
 // copyright on the Program, and are irrevocable provided the stated  
 // conditions are met.  This License explicitly affirms your unlimited  
 // permission to run the unmodified Program.  The output from running a  
 // covered work is covered by this License only if the output, given its  
 // content, constitutes a covered work.  This License acknowledges your  
 // rights of fair use or other equivalent, as provided by copyright law.  
 //  
 //   You may make, run and propagate covered works that you do not  
 // convey, without conditions so long as your license otherwise remains  
 // in force.  You may convey covered works to others for the sole purpose  
 // of having them make modifications exclusively for you, or provide you  
 // with facilities for running those works, provided that you comply with  
 // the terms of this License in conveying all material for which you do  
 // not control copyright.  Those thus making or running the covered works  
 // for you must do so exclusively on your behalf, under your direction  
 // and control, on terms that prohibit them from making any copies of  
 // your copyrighted material outside their relationship with you.  
 //  
 //   Conveying under any other circumstances is permitted solely under  
 // the conditions stated below.  Sublicensing is not allowed; section 10  
 // makes it unnecessary.  
 //  
 //   3. Protecting Users' Legal Rights From Anti-Circumvention Law.  
 //  
 //   No covered work shall be deemed part of an effective technological  
 // measure under any applicable law fulfilling obligations under article  
 // 11 of the WIPO copyright treaty adopted on 20 December 1996, or  
 // similar laws prohibiting or restricting circumvention of such  
 // measures.  
 //  
 //   When you convey a covered work, you waive any legal power to forbid  
 // circumvention of technological measures to the extent such circumvention  
 // is effected by exercising rights under this License with respect to  
 // the covered work, and you disclaim any intention to limit operation or  
 // modification of the work as a means of enforcing, against the work's  
 // users, your or third parties' legal rights to forbid circumvention of  
 // technological measures.  
 //  
 //   4. Conveying Verbatim Copies.  
 //  
 //   You may convey 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;  
 // keep intact all notices stating that this License and any  
 // non-permissive terms added in accord with section 7 apply to the code;  
 // keep intact all notices of the absence of any warranty; and give all  
 // recipients a copy of this License along with the Program.  
 //  
 //   You may charge any price or no price for each copy that you convey,  
 // and you may offer support or warranty protection for a fee.  
 //  
 //   5. Conveying Modified Source Versions.  
 //  
 //   You may convey a work based on the Program, or the modifications to  
 // produce it from the Program, in the form of source code under the  
 // terms of section 4, provided that you also meet all of these conditions:  
 //  
 //     a) The work must carry prominent notices stating that you modified  
 //     it, and giving a relevant date.  
 //  
 //     b) The work must carry prominent notices stating that it is  
 //     released under this License and any conditions added under section  
 //     7.  This requirement modifies the requirement in section 4 to  
 //     "keep intact all notices".  
 //  
 //     c) You must license the entire work, as a whole, under this  
 //     License to anyone who comes into possession of a copy.  This  
 //     License will therefore apply, along with any applicable section 7  
 //     additional terms, to the whole of the work, and all its parts,  
 //     regardless of how they are packaged.  This License gives no  
 //     permission to license the work in any other way, but it does not  
 //     invalidate such permission if you have separately received it.  
 //  
 //     d) If the work has interactive user interfaces, each must display  
 //     Appropriate Legal Notices; however, if the Program has interactive  
 //     interfaces that do not display Appropriate Legal Notices, your  
 //     work need not make them do so.  
 //  
 //   A compilation of a covered work with other separate and independent  
 // works, which are not by their nature extensions of the covered work,  
 // and which are not combined with it such as to form a larger program,  
 // in or on a volume of a storage or distribution medium, is called an  
 // "aggregate" if the compilation and its resulting copyright are not  
 // used to limit the access or legal rights of the compilation's users  
 // beyond what the individual works permit.  Inclusion of a covered work  
 // in an aggregate does not cause this License to apply to the other  
 // parts of the aggregate.  
 //  
 //   6. Conveying Non-Source Forms.  
 //  
 //   You may convey a covered work in object code form under the terms  
 // of sections 4 and 5, provided that you also convey the  
 // machine-readable Corresponding Source under the terms of this License,  
 // in one of these ways:  
 //  
 //     a) Convey the object code in, or embodied in, a physical product  
 //     (including a physical distribution medium), accompanied by the  
 //     Corresponding Source fixed on a durable physical medium  
 //     customarily used for software interchange.  
 //  
 //     b) Convey the object code in, or embodied in, a physical product  
 //     (including a physical distribution medium), accompanied by a  
 //     written offer, valid for at least three years and valid for as  
 //     long as you offer spare parts or customer support for that product  
 //     model, to give anyone who possesses the object code either (1) a  
 //     copy of the Corresponding Source for all the software in the  
 //     product that is covered by this License, on a durable physical  
 //     medium customarily used for software interchange, for a price no  
 //     more than your reasonable cost of physically performing this  
 //     conveying of source, or (2) access to copy the  
 //     Corresponding Source from a network server at no charge.  
 //  
 //     c) Convey individual copies of the object code with a copy of the  
 //     written offer to provide the Corresponding Source.  This  
 //     alternative is allowed only occasionally and noncommercially, and  
 //     only if you received the object code with such an offer, in accord  
 //     with subsection 6b.  
 //  
 //     d) Convey the object code by offering access from a designated  
 //     place (gratis or for a charge), and offer equivalent access to the  
 //     Corresponding Source in the same way through the same place at no  
 //     further charge.  You need not require recipients to copy the  
 //     Corresponding Source along with the object code.  If the place to  
 //     copy the object code is a network server, the Corresponding Source  
 //     may be on a different server (operated by you or a third party)  
 //     that supports equivalent copying facilities, provided you maintain  
 //     clear directions next to the object code saying where to find the  
 //     Corresponding Source.  Regardless of what server hosts the  
 //     Corresponding Source, you remain obligated to ensure that it is  
 //     available for as long as needed to satisfy these requirements.  
 //  
 //     e) Convey the object code using peer-to-peer transmission, provided  
 //     you inform other peers where the object code and Corresponding  
 //     Source of the work are being offered to the general public at no  
 //     charge under subsection 6d.  
 //  
 //   A separable portion of the object code, whose source code is excluded  
 // from the Corresponding Source as a System Library, need not be  
 // included in conveying the object code work.  
 //  
 //   A "User Product" is either (1) a "consumer product", which means any  
 // tangible personal property which is normally used for personal, family,  
 // or household purposes, or (2) anything designed or sold for incorporation  
 // into a dwelling.  In determining whether a product is a consumer product,  
 // doubtful cases shall be resolved in favor of coverage.  For a particular  
 // product received by a particular user, "normally used" refers to a  
 // typical or common use of that class of product, regardless of the status  
 // of the particular user or of the way in which the particular user  
 // actually uses, or expects or is expected to use, the product.  A product  
 // is a consumer product regardless of whether the product has substantial  
 // commercial, industrial or non-consumer uses, unless such uses represent  
 // the only significant mode of use of the product.  
 //  
 //   "Installation Information" for a User Product means any methods,  
 // procedures, authorization keys, or other information required to install  
 // and execute modified versions of a covered work in that User Product from  
 // a modified version of its Corresponding Source.  The information must  
 // suffice to ensure that the continued functioning of the modified object  
 // code is in no case prevented or interfered with solely because  
 // modification has been made.  
 //  
 //   If you convey an object code work under this section in, or with, or  
 // specifically for use in, a User Product, and the conveying occurs as  
 // part of a transaction in which the right of possession and use of the  
 // User Product is transferred to the recipient in perpetuity or for a  
 // fixed term (regardless of how the transaction is characterized), the  
 // Corresponding Source conveyed under this section must be accompanied  
 // by the Installation Information.  But this requirement does not apply  
 // if neither you nor any third party retains the ability to install  
 // modified object code on the User Product (for example, the work has  
 // been installed in ROM).  
 //  
 //   The requirement to provide Installation Information does not include a  
 // requirement to continue to provide support service, warranty, or updates  
 // for a work that has been modified or installed by the recipient, or for  
 // the User Product in which it has been modified or installed.  Access to a  
 // network may be denied when the modification itself materially and  
 // adversely affects the operation of the network or violates the rules and  
 // protocols for communication across the network.  
 //  
 //   Corresponding Source conveyed, and Installation Information provided,  
 // in accord with this section must be in a format that is publicly  
 // documented (and with an implementation available to the public in  
 // source code form), and must require no special password or key for  
 // unpacking, reading or copying.  
 //  
 //   7. Additional Terms.  
 //  
 //   "Additional permissions" are terms that supplement the terms of this  
 // License by making exceptions from one or more of its conditions.  
 // Additional permissions that are applicable to the entire Program shall  
 // be treated as though they were included in this License, to the extent  
 // that they are valid under applicable law.  If additional permissions  
 // apply only to part of the Program, that part may be used separately  
 // under those permissions, but the entire Program remains governed by  
 // this License without regard to the additional permissions.  
 //  
 //   When you convey a copy of a covered work, you may at your option  
 // remove any additional permissions from that copy, or from any part of  
 // it.  (Additional permissions may be written to require their own  
 // removal in certain cases when you modify the work.)  You may place  
 // additional permissions on material, added by you to a covered work,  
 // for which you have or can give appropriate copyright permission.  
 //  
 //   Notwithstanding any other provision of this License, for material you  
 // add to a covered work, you may (if authorized by the copyright holders of  
 // that material) supplement the terms of this License with terms:  
 //  
 //     a) Disclaiming warranty or limiting liability differently from the  
 //     terms of sections 15 and 16 of this License; or  
 //  
 //     b) Requiring preservation of specified reasonable legal notices or  
 //     author attributions in that material or in the Appropriate Legal  
 //     Notices displayed by works containing it; or  
 //  
 //     c) Prohibiting misrepresentation of the origin of that material, or  
 //     requiring that modified versions of such material be marked in  
 //     reasonable ways as different from the original version; or  
 //  
 //     d) Limiting the use for publicity purposes of names of licensors or  
 //     authors of the material; or  
 //  
 //     e) Declining to grant rights under trademark law for use of some  
 //     trade names, trademarks, or service marks; or  
 //  
 //     f) Requiring indemnification of licensors and authors of that  
 //     material by anyone who conveys the material (or modified versions of  
 //     it) with contractual assumptions of liability to the recipient, for  
 //     any liability that these contractual assumptions directly impose on  
 //     those licensors and authors.  
 //  
 //   All other non-permissive additional terms are considered "further  
 // restrictions" within the meaning of section 10.  If the Program as you  
 // received it, or any part of it, contains a notice stating that it is  
 // governed by this License along with a term that is a further  
 // restriction, you may remove that term.  If a license document contains  
 // a further restriction but permits relicensing or conveying under this  
 // License, you may add to a covered work material governed by the terms  
 // of that license document, provided that the further restriction does  
 // not survive such relicensing or conveying.  
 //  
 //   If you add terms to a covered work in accord with this section, you  
 // must place, in the relevant source files, a statement of the  
 // additional terms that apply to those files, or a notice indicating  
 // where to find the applicable terms.  
 //  
 //   Additional terms, permissive or non-permissive, may be stated in the  
 // form of a separately written license, or stated as exceptions;  
 // the above requirements apply either way.  
 //  
 //   8. Termination.  
 //  
 //   You may not propagate or modify a covered work except as expressly  
 // provided under this License.  Any attempt otherwise to propagate or  
 // modify it is void, and will automatically terminate your rights under  
 // this License (including any patent licenses granted under the third  
 // paragraph of section 11).  
 //  
 //   However, if you cease all violation of this License, then your  
 // license from a particular copyright holder is reinstated (a)  
 // provisionally, unless and until the copyright holder explicitly and  
 // finally terminates your license, and (b) permanently, if the copyright  
 // holder fails to notify you of the violation by some reasonable means  
 // prior to 60 days after the cessation.  
 //  
 //   Moreover, your license from a particular copyright holder is  
 // reinstated permanently if the copyright holder notifies you of the  
 // violation by some reasonable means, this is the first time you have  
 // received notice of violation of this License (for any work) from that  
 // copyright holder, and you cure the violation prior to 30 days after  
 // your receipt of the notice.  
 //  
 //   Termination of your rights under this section does not terminate the  
 // licenses of parties who have received copies or rights from you under  
 // this License.  If your rights have been terminated and not permanently  
 // reinstated, you do not qualify to receive new licenses for the same  
 // material under section 10.  
 //  
 //   9. Acceptance Not Required for Having Copies.  
 //  
 //   You are not required to accept this License in order to receive or  
 // run a copy of the Program.  Ancillary propagation of a covered work  
 // occurring solely as a consequence of using peer-to-peer transmission  
 // to receive a copy likewise does not require acceptance.  However,  
 // nothing other than this License grants you permission to propagate or  
 // modify any covered work.  These actions infringe copyright if you do  
 // not accept this License.  Therefore, by modifying or propagating a  
 // covered work, you indicate your acceptance of this License to do so.  
 //  
 //   10. Automatic Licensing of Downstream Recipients.  
 //  
 //   Each time you convey a covered work, the recipient automatically  
 // receives a license from the original licensors, to run, modify and  
 // propagate that work, subject to this License.  You are not responsible  
 // for enforcing compliance by third parties with this License.  
 //  
 //   An "entity transaction" is a transaction transferring control of an  
 // organization, or substantially all assets of one, or subdividing an  
 // organization, or merging organizations.  If propagation of a covered  
 // work results from an entity transaction, each party to that  
 // transaction who receives a copy of the work also receives whatever  
 // licenses to the work the party's predecessor in interest had or could  
 // give under the previous paragraph, plus a right to possession of the  
 // Corresponding Source of the work from the predecessor in interest, if  
 // the predecessor has it or can get it with reasonable efforts.  
 //  
 //   You may not impose any further restrictions on the exercise of the  
 // rights granted or affirmed under this License.  For example, you may  
 // not impose a license fee, royalty, or other charge for exercise of  
 // rights granted under this License, and you may not initiate litigation  
 // (including a cross-claim or counterclaim in a lawsuit) alleging that  
 // any patent claim is infringed by making, using, selling, offering for  
 // sale, or importing the Program or any portion of it.  
 //  
 //   11. Patents.  
 //  
 //   A "contributor" is a copyright holder who authorizes use under this  
 // License of the Program or a work on which the Program is based.  The  
 // work thus licensed is called the contributor's "contributor version".  
 //  
 //   A contributor's "essential patent claims" are all patent claims  
 // owned or controlled by the contributor, whether already acquired or  
 // hereafter acquired, that would be infringed by some manner, permitted  
 // by this License, of making, using, or selling its contributor version,  
 // but do not include claims that would be infringed only as a  
 // consequence of further modification of the contributor version.  For  
 // purposes of this definition, "control" includes the right to grant  
 // patent sublicenses in a manner consistent with the requirements of  
 // this License.  
 //  
 //   Each contributor grants you a non-exclusive, worldwide, royalty-free  
 // patent license under the contributor's essential patent claims, to  
 // make, use, sell, offer for sale, import and otherwise run, modify and  
 // propagate the contents of its contributor version.  
 //  
 //   In the following three paragraphs, a "patent license" is any express  
 // agreement or commitment, however denominated, not to enforce a patent  
 // (such as an express permission to practice a patent or covenant not to  
 // sue for patent infringement).  To "grant" such a patent license to a  
 // party means to make such an agreement or commitment not to enforce a  
 // patent against the party.  
 //  
 //   If you convey a covered work, knowingly relying on a patent license,  
 // and the Corresponding Source of the work is not available for anyone  
 // to copy, free of charge and under the terms of this License, through a  
 // publicly available network server or other readily accessible means,  
 // then you must either (1) cause the Corresponding Source to be so  
 // available, or (2) arrange to deprive yourself of the benefit of the  
 // patent license for this particular work, or (3) arrange, in a manner  
 // consistent with the requirements of this License, to extend the patent  
 // license to downstream recipients.  "Knowingly relying" means you have  
 // actual knowledge that, but for the patent license, your conveying the  
 // covered work in a country, or your recipient's use of the covered work  
 // in a country, would infringe one or more identifiable patents in that  
 // country that you have reason to believe are valid.  
 //  
 //   If, pursuant to or in connection with a single transaction or  
 // arrangement, you convey, or propagate by procuring conveyance of, a  
 // covered work, and grant a patent license to some of the parties  
 // receiving the covered work authorizing them to use, propagate, modify  
 // or convey a specific copy of the covered work, then the patent license  
 // you grant is automatically extended to all recipients of the covered  
 // work and works based on it.  
 //  
 //  A patent license is "discriminatory" if it does not include within  
 // the scope of its coverage, prohibits the exercise of, or is  
 // conditioned on the non-exercise of one or more of the rights that are  
 // specifically granted under this License.  You may not convey a covered  
 // work if you are a party to an arrangement with a third party that is  
 // in the business of distributing software, under which you make payment  
 // to the third party based on the extent of your activity of conveying  
 // the work, and under which the third party grants, to any of the  
 // parties who would receive the covered work from you, a discriminatory  
 // patent license (a) in connection with copies of the covered work  
 // conveyed by you (or copies made from those copies), or (b) primarily  
 // for and in connection with specific products or compilations that  
 // contain the covered work, unless you entered into that arrangement,  
 // or that patent license was granted, prior to 28 March 2007.  
 //  
 //   Nothing in this License shall be construed as excluding or limiting  
 // any implied license or other defenses to infringement that may  
 // otherwise be available to you under applicable patent law.  
 //  
 //   12. No Surrender of Others' Freedom.  
 //  
 //   If conditions are imposed on you (whether by court order, agreement or  
 // otherwise) that contradict the conditions of this License, they do not  
 // excuse you from the conditions of this License.  If you cannot convey a  
 // covered work so as to satisfy simultaneously your obligations under this  
 // License and any other pertinent obligations, then as a consequence you may  
 // not convey it at all.  For example, if you agree to terms that obligate you  
 // to collect a royalty for further conveying from those to whom you convey  
 // the Program, the only way you could satisfy both those terms and this  
 // License would be to refrain entirely from conveying the Program.  
 //  
 //   13. Use with the GNU Affero General Public License.  
 //  
 //   Notwithstanding any other provision of this License, you have  
 // permission to link or combine any covered work with a work licensed  
 // under version 3 of the GNU Affero General Public License into a single  
 // combined work, and to convey the resulting work.  The terms of this  
 // License will continue to apply to the part which is the covered work,  
 // but the special requirements of the GNU Affero General Public License,  
 // section 13, concerning interaction through a network will apply to the  
 // combination as such.  
 //  
 //   14. Revised Versions of this License.  
 //  
 //   The Free Software Foundation may publish revised and/or new versions of  
 // the GNU 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 that a certain numbered version of the GNU General  
 // Public License "or any later version" applies to it, you have the  
 // option of following the terms and conditions either of that numbered  
 // version or of any later version published by the Free Software  
 // Foundation.  If the Program does not specify a version number of the  
 // GNU General Public License, you may choose any version ever published  
 // by the Free Software Foundation.  
 //  
 //   If the Program specifies that a proxy can decide which future  
 // versions of the GNU General Public License can be used, that proxy's  
 // public statement of acceptance of a version permanently authorizes you  
 // to choose that version for the Program.  
 //  
 //   Later license versions may give you additional or different  
 // permissions.  However, no additional obligations are imposed on any  
 // author or copyright holder as a result of your choosing to follow a  
 // later version.  
 //  
 //   15. Disclaimer of Warranty.  
 //  
 //   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.  
 //  
 //   16. Limitation of Liability.  
 //  
 //   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING  
 // WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS  
 // 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.  
 //  
 //   17. Interpretation of Sections 15 and 16.  
 //  
 //   If the disclaimer of warranty and limitation of liability provided  
 // above cannot be given local legal effect according to their terms,  
 // reviewing courts shall apply local law that most closely approximates  
 // an absolute waiver of all civil liability in connection with the  
 // Program, unless a warranty or assumption of liability accompanies a  
 // copy of the Program in return for a fee.  
 //--------------------------------------------------------------------------------  
 //C O N F I G U R A T I O N  
 //--------------------------------------------------------------------------------  
 //Configuration switch combinations were not tested.  E-mail me any program  
 //corrections (dashley@gmail.com).  
 define ("CFG_PROGNAME", "filenames_canonize.php");  
    //Number of characters per line preferred for console output.  
 define ("CFG_CONSOLE_STD_LINE_LEN", 78);  
    //Number of characters per line preferred for console output.  
 define (  
    "CFG_FILENAME_SUBSTITUTION_MAP",  
    ".."                                                    //Dots unchanged.  
    .  
    "aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz"  //LC letters unchanged.  
    .  
    "AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz"  //UC converted to LC.  
    .  
    "00112233445566778899"                                  //Digits unchanged.  
    .  
    "-_"                                                    //Hyphens become underscores,  
                                                            //and anything unmapped  
                                                            //becomes an underscore.  
    );  
    //Pairs of characters, the first is the character to match and the second  
    //is the replacement.  Any characters not found in the map will be replaced  
    //by the last character of the constant.  
 //--------------------------------------------------------------------------------  
 //Repeats a character to the console output a certain number of times.  
 function rep_char_con($c, $n)  
 {  
    while ($n--)  
       echo $c;  
 }  
 //--------------------------------------------------------------------------------  
 //Writes a standard thick horizontal line to the console.  
 function hor_line_thick()  
 {  
    rep_char_con("=", CFG_CONSOLE_STD_LINE_LEN);  
    echo "\n";  
 }  
 //--------------------------------------------------------------------------------  
 //Writes a standard thin horizontal line to the console.  
 function hor_line_thin()  
 {  
    rep_char_con("-", CFG_CONSOLE_STD_LINE_LEN);  
    echo "\n";  
 }  
 //--------------------------------------------------------------------------------  
 //Returns an array of all files in the working directory.  
 //If no files can be found, returns FALSE.  
 function get_file_names_in_dir()  
 {  
    //Get directory list.  
    $rv = scandir (".");  
   
    //If the list is empty, something went wrong.  Return FALSE.  
    if ($rv === FALSE)  
       return FALSE;  
   
    return $rv;  
 }  
 //--------------------------------------------------------------------------------  
 //Canonizes a filename by performing character substitutions.  
 function canonize($in_fname)  
 {  
    //Well, the algorithm below is O(N^2) or worse ... I knew there was a reason  
    //that computers get faster every year.  
    $out_fname = "";  
   
    for ($i = 0; $i < strlen($in_fname); $i++)  
    {  
       $map = CFG_FILENAME_SUBSTITUTION_MAP;  
       $c = substr($in_fname, $i, 1);  
   
       $sub_made = FALSE;  
       while (strlen($map) >= 2)  
       {  
          if (substr($map, 0, 1) == $c)  
          {  
             $c = substr($map, 1, 1);  
             $sub_made = TRUE;  
             break;  
          }  
          else  
          {  
             $map = substr($map, 2);  
          }  
       }  
   
       if (! $sub_made)  
       {  
          $c = substr(CFG_FILENAME_SUBSTITUTION_MAP, strlen(CFG_FILENAME_SUBSTITUTION_MAP) - 1, 1);  
          //echo "Default sub made: " . $c . "\n";  
       }  
   
       $out_fname = $out_fname . $c;  
    }  
   
    return $out_fname;  
 }  
 //--------------------------------------------------------------------------------  
    //Write introductory message.  
    hor_line_thick();  
    echo CFG_PROGNAME . " Copyright (C) 2015 David T. Ashley\n";  
    echo "This program comes with ABSOLUTELY NO WARRANTY; and is licensed under\n";  
    echo "the GNU General Public License, Version 3.  A copy of this license is\n";  
    echo "provided in the source code of this program.\n";  
    hor_line_thin();  
    //-----------------------------------------------------------------------------  
    //Get and emit the names of everything in the directory.  
    $file_list = get_file_names_in_dir();  
    if ($file_list === FALSE)  
    {  
       echo "List of files from PHP function scandir() is empty.\n";  
       echo "Serious internal error, or nothing to do.  Script cannot continue.\n";  
       hor_line_thick();  
       exit(1);  
    }  
    else  
    {  
      echo "Files in working directory (unsorted, unfiltered, "  
           .  
           count($file_list)  
           .  
           " files):\n";  
      for ($i = 0; $i < count($file_list); $i++)  
         echo "   " . sprintf("[%5d]", $i) . " " . $file_list[$i] . "\n";  
    }  
    hor_line_thin();  
    //-----------------------------------------------------------------------------  
    //Remove everything that is not a file we can rename.  
    $temp_list = $file_list;  
    unset($file_list);  
    $n = 0;  
    for ($i = 0; $i < count($temp_list); $i++)  
    {  
       //echo "Checking " . $temp_list[$i] . "\n";  
   
       if (strcmp($temp_list[$i], ".") == 0)  
       {  
          //. entry, not a file.  
       }  
       else if (strcmp($temp_list[$i], "..") == 0)  
       {  
          //.. entry, not a file.  
       }  
       else if (is_file($temp_list[$i]))  
       {  
          //This is a regular file.  
          $file_list[] = $temp_list[$i];  
          $n++;  
       }  
    }  
     
    if ($n == 0)  
       $file_list = FALSE;  
   
    unset($n);  
    unset($temp_list);  
    //-----------------------------------------------------------------------------  
    //If there is nothing to do, end the script.  
    if ($file_list === FALSE)  
    {  
       echo "No files to rename.\n";  
       hor_line_thick();  
       exit(0);  
    }  
    //-----------------------------------------------------------------------------  
    //Sort the list.  This is a non-event.  The only rationale for sorting is that  
    //it ensures that the same set of files will be processed in the same order,  
    //regardless of the order provided by the underlying OS internals.  
    sort($file_list);  
    //-----------------------------------------------------------------------------  
    //Emit the names we now have.  
    echo "Files in working directory (directory entries removed, sorted, "  
         .  
         count($file_list)  
         .  
         " files):\n";  
    for ($i = 0; $i < count($file_list); $i++)  
       echo "   " . sprintf("[%5d]", $i) . " " . $file_list[$i] . "\n";  
    hor_line_thin();  
    //-----------------------------------------------------------------------------  
    //For each file in the directory, form a filename which would be the result  
    //of applying character substitutions and any other corrections.  
    for ($i = 0; $i < count($file_list); $i++)  
    {  
       $rename_target[$i] = canonize($file_list[$i]);  
   
       //echo $file_list[$i] . " " . $rename_target[$i] . "\n";  
    }  
    //-----------------------------------------------------------------------------  
    //In all those cases where the name of the file as we would like it to be is  
    //different from the name of the file as it exists, rename it.  Watch for  
    //collisions, because renaming on top of a file represents the loss of  
    //data.  
    $n = 0;  
    for ($i = 0; $i < count($file_list); $i++)  
    {  
       if (strcmp($file_list[$i], $rename_target[$i]) != 0)  
          $n++;  
    }  
   
    if ($n == 0)  
    {  
       echo "No files need to be renamed.\n";  
       hor_line_thin();  
    }  
    else  
    {  
       echo "Renaming " . $n . " file(s).\n";  
       hor_line_thin();  
   
       $count = 0;  
       for ($i = 0; $i < count($file_list); $i++)  
       {  
          if (strcmp($file_list[$i], $rename_target[$i]) != 0)  
          {  
             $count++;  
             echo "[" . sprintf("%5d/%5d", $count, $n) . "]"  
                  .  
                  " Renaming " . $file_list[$i] . " to " . $rename_target[$i] . " ... ";  
             if (file_exists($rename_target[$i]))  
             {  
                echo "Aborted.\nRename target already exists.\n";  
                echo "Choose non-colliding filenames and run this script again.\n";  
                echo "Script terminating.\n";  
                hor_line_thin();  
                exit(1);  
             }  
   
             $result = rename($file_list[$i], $rename_target[$i]);  
             if ($result)  
             {  
                echo "Done.\n";  
                hor_line_thin();  
             }  
             else  
             {  
                echo "Failed.\nScript must terminate.\n";  
                hor_line_thick();  
                exit(1);  
             }  
          }  
       }  
    }  
    //-----------------------------------------------------------------------------  
    echo CFG_PROGNAME . " execution ends.\n";  
    hor_line_thick();  
 //--------------------------------------------------------------------------------  
 //End of File  
 //--------------------------------------------------------------------------------  
 ?>  

Legend:
Removed from v.34  
changed lines
  Added in v.115

dashley@gmail.com
ViewVC Help
Powered by ViewVC 1.1.25