From 4898f42e184c4583a5f41cbbd7ee89c21ae5a271 Mon Sep 17 00:00:00 2001 From: Mark Holmquist Date: Wed, 7 Aug 2013 16:59:08 +0800 Subject: [PATCH] Initial commit - working demo Works with the new multilightbox library from https://gitorious.org/multilightbox/multilightbox Also has fullscreen and close. Very fun. Change-Id: I6d61f6590843e1767bc7492dbd98e6aa3b85fcdc --- COPYING | 339 ++++++++++++++++++++++++++ MultimediaViewer.i18n.php | 42 ++++ MultimediaViewer.php | 90 +++++++ MultimediaViewerHooks.php | 51 ++++ css/ext.multimediaViewer.css | 65 +++++ css/multilightbox.css | 88 +++++++ img/circle.svg | 1 + img/close.svg | 1 + img/defullscreen.svg | 1 + img/fullscreen.svg | 1 + js/ext.multimediaViewer.js | 74 ++++++ js/multilightbox/hooks.txt | 64 +++++ js/multilightbox/lightboximage.js | 85 +++++++ js/multilightbox/lightboxinterface.js | 192 +++++++++++++++ js/multilightbox/multilightbox.js | 135 ++++++++++ 15 files changed, 1229 insertions(+) create mode 100644 COPYING create mode 100644 MultimediaViewer.i18n.php create mode 100644 MultimediaViewer.php create mode 100644 MultimediaViewerHooks.php create mode 100644 css/ext.multimediaViewer.css create mode 100644 css/multilightbox.css create mode 100644 img/circle.svg create mode 100644 img/close.svg create mode 100644 img/defullscreen.svg create mode 100644 img/fullscreen.svg create mode 100644 js/ext.multimediaViewer.js create mode 100644 js/multilightbox/hooks.txt create mode 100644 js/multilightbox/lightboximage.js create mode 100644 js/multilightbox/lightboxinterface.js create mode 100644 js/multilightbox/multilightbox.js diff --git a/COPYING b/COPYING new file mode 100644 index 000000000..d159169d1 --- /dev/null +++ b/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + 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 +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This 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. diff --git a/MultimediaViewer.i18n.php b/MultimediaViewer.i18n.php new file mode 100644 index 000000000..3a106a521 --- /dev/null +++ b/MultimediaViewer.i18n.php @@ -0,0 +1,42 @@ +. + * + * @file + * @ingroup extensions + */ + +/** + * English + * @author Mark Holmquist + */ +$messages['en'] = array( + 'multimediaviewer-desc' => 'Adds a nicer-looking multimedia viewer for images.', + 'multimediaviewer-pref' => 'Enable nicer image viewing', + 'multimediaviewer-pref-desc' => 'Enables a nicer-looking multimedia viewer for images on pages that have thumbnails. Uses a third party lightbox library and JavaScript.', + 'multimediaviewer-file-page' => 'Go to corresponding file page', +); + +/** + * Message documentation + * @author Mark Holmquist + */ +$messages['qqq'] = array( + 'multimediaviewer-desc' => 'Description of the extension for Special:Version', + 'multimediaviewer-pref' => 'Preference title', + 'multimediaviewer-pref-desc' => 'Description of preference', + 'multimediaviewer-file-page' => 'Text for a link to the file page for an image.', +); diff --git a/MultimediaViewer.php b/MultimediaViewer.php new file mode 100644 index 000000000..e9797a571 --- /dev/null +++ b/MultimediaViewer.php @@ -0,0 +1,90 @@ +. + * + * @file + * @ingroup extensions + * @author Mark Holmquist + * @copyright Copyright © 2013, Mark Holmquist + */ + +$moduleInfo = array( + 'localBasePath' => __DIR__, + 'remoteExtPath' => 'MultimediaViewer', +); + +$wgExtensionMessagesFiles['MultimediaViewer'] = __DIR__ . '/MultimediaViewer.i18n.php'; + +$wgResourceModules['multilightbox.interface'] = array_merge( array( + 'scripts' => array( + 'js/multilightbox/lightboxinterface.js', + ), + + 'styles' => array( + 'css/multilightbox.css', + ), +), $moduleInfo ); + +$wgResourceModules['multilightbox.image'] = array_merge( array( + 'scripts' => array( + 'js/multilightbox/lightboximage.js', + ), +), $moduleInfo ); + +$wgResourceModules['multilightbox'] = array_merge( array( + 'scripts' => array( + 'js/multilightbox/multilightbox.js', + ), + + 'dependencies' => array( + 'multilightbox.interface', + ), +), $moduleInfo ); + +$wgResourceModules['ext.multimediaViewer'] = array_merge( array( + 'scripts' => array( + 'js/ext.multimediaViewer.js', + ), + + 'styles' => array( + 'css/ext.multimediaViewer.css', + ), + + 'dependencies' => array( + 'multilightbox', + 'multilightbox.image', + ), + + 'messages' => array( + 'multimediaviewer-file-page', + ), +), $moduleInfo ); + + +$wgAutoloadClasses['MultimediaViewerHooks'] = __DIR__ . '/MultimediaViewerHooks.php'; +$wgHooks['GetBetaFeaturePreferences'][] = 'MultimediaViewerHooks::getBetaPreferences'; +$wgHooks['BeforePageDisplay'][] = 'MultimediaViewerHooks::getModules'; + +$wgExtensionCredits['other'][] = array( + 'path' => __FILE__, + 'name' => 'MultimediaViewer', + 'descriptionmsg' => 'multimediaviewer-extension-description', + 'version' => '0.1', + 'author' => array( + 'MarkTraceur (Mark Holmquist)', + ), + 'url' => 'https://mediawiki.org/wiki/Extension:MultimediaViewer', +); diff --git a/MultimediaViewerHooks.php b/MultimediaViewerHooks.php new file mode 100644 index 000000000..e03fbc890 --- /dev/null +++ b/MultimediaViewerHooks.php @@ -0,0 +1,51 @@ +. + * + * @file + * @ingroup extensions + * @author Mark Holmquist + * @copyright Copyright © 2013, Mark Holmquist + */ + +class MultimediaViewerHooks { + + // Add JavaScript to the page when an image is on it + // and the user has enabled the feature. + static function getModules( &$out, &$skin ) { + if ( BetaFeatures::isFeatureEnabled( $out->getUser(), 'multimedia-viewer' ) && + count( $out->getFileSearchOptions() ) > 0 ) { + $out->addModules( array( 'ext.multimediaViewer' ) ); + } + + return true; + } + + // Add a beta preference to gate the feature + static function getBetaPreferences( $user, &$prefs ) { + global $wgExtensionAssetsPath; + + $prefs['multimedia-viewer'] = array( + 'label-message' => 'multimediaviewer-pref', + 'desc-message' => 'multimediaviewer-pref-desc', + 'info-link' => 'https://mediawiki.org/wiki/Extension:MultimediaViewer', + 'discussion-link' => 'https://mediawiki.org/wiki/Extension_talk:MultimediaViewer', + 'screenshot' => $wgExtensionAssetsPath . '/MultimediaViewer/images/screenshot.png', + ); + + return true; + } +} diff --git a/css/ext.multimediaViewer.css b/css/ext.multimediaViewer.css new file mode 100644 index 000000000..d74160f72 --- /dev/null +++ b/css/ext.multimediaViewer.css @@ -0,0 +1,65 @@ +.mw-lightbox-title-div { + text-align: left; + padding-left: 10px; + font-weight: bold; + + color: white; + + position: absolute; + bottom: 0px; + left: 0px; + right: 0px; + height: 50px; + + /* FF 3.6+ */ + background: -moz-linear-gradient(top, rgba(0,0,0,0) 0%, rgba(0,0,0,1) 100%); + + /* Chrome, Safari 4+ */ + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,rgba(0,0,0,0)), color-stop(100%,rgba(0,0,0,1))); + + /* Chrome 10+, Safari 5.1+ */ + background: -webkit-linear-gradient(top, rgba(0,0,0,0) 0%,rgba(0,0,0,1) 100%); + + /* Opera 11.10+ */ + background: -o-linear-gradient(top, rgba(0,0,0,0) 0%,rgba(0,0,0,1) 100%); + + /* IE10+ */ + background: -ms-linear-gradient(top, rgba(0,0,0,0) 0%,rgba(0,0,0,1) 100%); + + /* W3C */ + background: linear-gradient(to bottom, rgba(0,0,0,0) 0%,rgba(0,0,0,1) 100%); + + /* IE 6-9 */ + filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#00000000', endColorstr='#000000',GradientType=0 ); +} + +.mw-lightbox-extra-info-div { + height: 50px; + position: absolute; + bottom: -50px; + right: 0px; + left: 0px; + + background-color: black; + color: white; + + text-align: left; + padding-left: 10px; +} + +.mw-lightbox-extra-info-div a, +.mw-lightbox-extra-info-div a:hover, +.mw-lightbox-extra-info-div a:visited, +.mw-lightbox-extra-info-div a:active, +.mw-lightbox-extra-info-div a:link { + color: white; + text-decoration: none; +} + +.mw-lightbox .lb-container { + position: absolute; + top: 0px; + bottom: 0px; + left: 0px; + right: 0px; +} diff --git a/css/multilightbox.css b/css/multilightbox.css new file mode 100644 index 000000000..260963e7d --- /dev/null +++ b/css/multilightbox.css @@ -0,0 +1,88 @@ +.mlb-overlay { + position: fixed; + top: 0px; + left: 0px; + right: 0px; + bottom: 0px; + z-index: 1000; + background-color: rgba(0,0,0,0.9); +} + +.mlb-wrapper { + position: absolute; + top: 0px; + left: 0px; + right: 0px; + bottom: 0px; + z-index: 1001; +} + +.mlb-main { + margin-top: 20px; + width: 80%; + margin-right: auto; + margin-left: auto; + position: relative; +} + +.mlb-image { + width: 100%; +} + +.mlb-image img { + display: block; + margin-right: auto; + margin-left: auto; +} + +.mlb-controls { + margin-right: auto; + margin-left: auto; + width: 80%; + min-height: 32px; + border-bottom: 1px solid #7d7c81; + margin-bottom: 40px; + position: relative; +} + +.mlb-close { + cursor: pointer; + background-image: url("../img/close.svg"); + width: 32px; + height: 32px; + border-right: 1px solid #7d7c81; + border-bottom: 1px solid #7d7c81; + position: absolute; + bottom: -1px; + left: -32px; +} + +.mlb-fullscreen { + cursor: pointer; + background-image: url("../img/fullscreen.svg"); + width: 32px; + height: 32px; + border-left: 1px solid #7d7c81; + border-bottom: 1px solid #7d7c81; + position: absolute; + bottom: -1px; + right: -32px; +} + +.mlb-fullscreen-div { + position: absolute; + top: 0px; + left: 0px; + right: 0px; + bottom: 0px; + z-index: 1002; +} + +.mlb-fullscreen-div .mlb-main { + margin-top: 10px; + width: 100%; +} + +.mlb-fullscreen-div .mlb-fullscreen { + background-image: url("../img/defullscreen.svg"); +} diff --git a/img/circle.svg b/img/circle.svg new file mode 100644 index 000000000..e9c829b5e --- /dev/null +++ b/img/circle.svg @@ -0,0 +1 @@ + diff --git a/img/close.svg b/img/close.svg new file mode 100644 index 000000000..c9cbff6c7 --- /dev/null +++ b/img/close.svg @@ -0,0 +1 @@ + diff --git a/img/defullscreen.svg b/img/defullscreen.svg new file mode 100644 index 000000000..5c8664298 --- /dev/null +++ b/img/defullscreen.svg @@ -0,0 +1 @@ + diff --git a/img/fullscreen.svg b/img/fullscreen.svg new file mode 100644 index 000000000..d8ec7fcbb --- /dev/null +++ b/img/fullscreen.svg @@ -0,0 +1 @@ + diff --git a/js/ext.multimediaViewer.js b/js/ext.multimediaViewer.js new file mode 100644 index 000000000..08207ff50 --- /dev/null +++ b/js/ext.multimediaViewer.js @@ -0,0 +1,74 @@ +/* + * This file is part of the MediaWiki extension MultimediaViewer. + * + * MultimediaViewer 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 2 of the License, or + * (at your option) any later version. + * + * MultimediaViewer 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 MultimediaViewer. If not, see . + */ + +( function ( mw, $ ) { + var MultiLightbox, LightboxImage, lightboxHooks; + + function MultimediaViewer() { + var $thumbs = $( '.thumbimage' ), + urls = [], + viewer = this; + + $thumbs.each( function ( i, thumb ) { + var $thumb = $( thumb ), + $link = $thumb.closest( 'a.image' ), + $thumbContain = $link.closest( '.thumb' ), + $enlarge = $thumbContain.find( '.magnify a' ), + $links = $link.add( $enlarge ), + filePageLink = $link.prop( 'href' ), + filename = $thumb.prop( 'alt' ), + articlePath = mw.config.get( 'wgArticlePath' ), + index = urls.length, + fileLink = articlePath.replace( '$1', 'Special:Filepath/' + filename ); + + $links.data( 'filePageLink', filePageLink ); + urls.push( new LightboxImage( fileLink ) ); + urls[index].filePageLink = filePageLink; + + $links.click( function ( e ) { + e.preventDefault(); + viewer.lightbox.currentIndex = index; + viewer.lightbox.open(); + return false; + } ); + } ); + + if ( $thumbs.length > 0 ) { + this.lightbox = new MultiLightbox( urls ); + } + + lightboxHooks.register( 'imageLoaded', function () { + // Add link wrapper to the image div, put image inside it + this.$imageLink = $( '' ) + .addClass( 'mw-mlb-image-link' ) + .html( this.$image.detach() ); + + this.$imageDiv.append( this.$imageLink ); + } ); + } + + $( function () { + MultiLightbox = window.MultiLightbox; + LightboxImage = window.LightboxImage; + lightboxHooks = window.lightboxHooks; + + var viewer = new MultimediaViewer(); + mw.mediaViewer = viewer; + } ); + + mw.MultimediaViewer = MultimediaViewer; +}( mediaWiki, jQuery ) ); diff --git a/js/multilightbox/hooks.txt b/js/multilightbox/hooks.txt new file mode 100644 index 000000000..bbcbf04cd --- /dev/null +++ b/js/multilightbox/hooks.txt @@ -0,0 +1,64 @@ +These are the available hook types. You can register functions to handle these +by calling lightboxHooks.register( 'typeOfHook', function () { ... } ); + +modifyInterface + Arguments: None + ThisArg: LightboxInterface + Called: From LightboxInterface constructor + +modifyDefaultPreDiv + Arguments: None + ThisArg: LightboxInterface + Called: From LightboxInterface setupPreDiv method, if defaults are loaded + +modifyDefaultPostDiv + Arguments: None + ThisArg: LightboxInterface + Called: From LightboxInterface setupPostDiv method, if defaults are loaded + +addToPreDiv + Arguments: + * addToPre - Array - Add jQuery elements here to be added to the pre-image div + ThisArg: LightboxInterface + Called: From LightboxInterface constructor + +addToPostDiv + Arguments: + * addToPost - Array - Add jQuery elements here to be added to the post-image div + ThisArg: LightboxInterface + Called: From LightboxInterface constructor + +imageLoaded + Arguments: None + ThisArg: LightboxInterface + Called: From LightboxInterface-defined callback when image is done loading + +modifyImageObject + Arguments: None + ThisArg: LightboxImage + Called: From LightboxImage constructor + +modifyImageElement + Arguments: None + ThisArg: HTMLImageElement + Called: From LightboxImage getImageElement method + +nextImage + Arguments: None + ThisArg: MultiLightbox + Called: From MultiLightbox next method + +prevImage + Arguments: None + ThisArg: MultiLightbox + Called: From MultiLightbox prev method + +noNextImage + Arguments: None + ThisArg: MultiLightbox + Called: From MultiLightbox next method when user tries to reach too-high index + +noPrevImage + Arguments: None + ThisArg: MultiLightbox + Called: From MultiLightbox prev method when user tries to reach negative index diff --git a/js/multilightbox/lightboximage.js b/js/multilightbox/lightboximage.js new file mode 100644 index 000000000..820545837 --- /dev/null +++ b/js/multilightbox/lightboximage.js @@ -0,0 +1,85 @@ +( function ( $ ) { + /** + * @class + * @constructor + * @param {string} src The URL (possibly relative) to the image + */ + function LightboxImage( src ) { + this.src = src; + + lightboxHooks.callAll( 'modifyImageObject', this ); + } + + var LIP = LightboxImage.prototype; + + LIP.getImageElement = function ( loadcb ) { + var ele; + + lightboxHooks.callAll( 'beforeFetchImage', this ); + + ele = new Image(); + ele.addEventListener( 'load', loadcb ); + ele.src = this.src; + + lightboxHooks.callAll( 'modifyImageElement', ele ); + + return ele; + }; + + LIP.autoResize = function ( ele ) { + function updateRatios() { + if ( imgHeight !== 0 ) { + imgHeightRatio = imgMaxHeight / imgHeight; + } + + if ( imgHeight !== 0 ) { + imgWidthRatio = imgMaxWidth / imgWidth; + } + } + + var imgWidthRatio, imgHeightRatio, + $window = $( window ), + winWidth = $window.width(), + winHeight = $window.height(), + $img = $( ele ), + imgMaxWidth = winWidth * 0.5, + imgMaxHeight = winHeight * 0.5, + imgWidth = $img.width(), + imgHeight = $img.height(); + + updateRatios(); + + if ( imgWidth > imgMaxWidth ) { + imgHeight *= imgWidthRatio || 1; + imgWidth = imgMaxWidth; + updateRatios(); + } + + if ( imgHeight > imgMaxHeight ) { + imgWidth *= imgHeightRatio || 1; + imgHeight = imgMaxHeight; + updateRatios(); + } + + if ( imgWidth < imgMaxWidth && imgHeight < imgMaxHeight ) { + if ( imgWidth === 0 && imgHeight === 0 ) { + // Only set one + imgWidth = imgMaxWidth; + imgHeight = null; + } else { + if ( imgHeightRatio > imgWidthRatio ) { + imgWidth *= imgHeightRatio; + imgHeight = imgMaxHeight; + } else { + imgHeight *= imgWidthRatio; + imgWidth = imgMaxWidth; + } + updateRatios(); + } + } + + $img.width( imgWidth ).height( imgHeight ); + }; + + window.LightboxImage = LightboxImage; +}( jQuery ) ); diff --git a/js/multilightbox/lightboxinterface.js b/js/multilightbox/lightboxinterface.js new file mode 100644 index 000000000..24af0ea1c --- /dev/null +++ b/js/multilightbox/lightboxinterface.js @@ -0,0 +1,192 @@ +( function ( $ ) { + var LIP, lightboxHooks; + + /** + * @class + * @constructor + */ + function LightboxInterface() { + lightboxHooks = window.lightboxHooks; + + function handleFullscreenChange() { + // If we're no longer in fullscreen mode, make sure + if ( !this.fullscreenButtonJustPressed && + !document.fullscreenElement && + !document.mozFullScreenElement && + !document.webkitFullScreenElement ) { + this.fullscreen(); + } else if ( this.fullscreenButtonJustPressed ) { + this.fullscreenButtonJustPressed = false; + } + } + + var result, + addToPre = [], + addToPost = []; + + this.$overlay = $( '
' ) + .addClass( 'mlb-overlay' ); + + this.$wrapper = $( '
' ) + .addClass( 'mlb-wrapper' ); + + this.$main = $( '
' ) + .addClass( 'mlb-main' ); + + this.$imageDiv = $( '
' ) + .addClass( 'mlb-image' ); + + this.$preDiv = $( '
' ) + .addClass( 'mlb-pre-image' ); + result = lightboxHooks.callAll( 'addToPreDiv', this, addToPre ); + this.setupPreDiv( result, addToPre ); + + this.$postDiv = $( '
' ) + .addClass( 'mlb-post-image' ); + result = lightboxHooks.callAll( 'addToPostDiv', this, addToPost ); + this.setupPostDiv( result, addToPost ); + + this.$main.append( + this.$preDiv, + this.$imageDiv, + this.$postDiv + ); + + this.$wrapper.append( + this.$main + ); + + lightboxHooks.callAll( 'modifyInterface', this ); + + window.addEventListener( 'keyup', function ( e ) { + if ( e.keyCode === 27 ) { + // Escape button pressed + this.unattach(); + } + }.bind( this ) ); + + window.addEventListener( 'fullscreenchange', handleFullscreenChange.bind( this ) ); + window.addEventListener( 'mozfullscreenchange', handleFullscreenChange.bind( this ) ); + window.addEventListener( 'webkitfullscreenchange', handleFullscreenChange.bind( this ) ); + } + + LIP = LightboxInterface.prototype; + + LIP.attach = function () { + $( document.body ) + .append( + this.$wrapper, + this.$overlay + ); + }; + + LIP.unattach = function () { + this.$wrapper.detach(); + this.$overlay.detach(); + }; + + LIP.fullscreen = function () { + var fullscreen; + + if ( this.isFullScreen ) { + if ( !document.fullscreenElement && + !document.mozFullScreenElement && + !document.webkitFullScreenElement ) { + if ( document.cancelFullScreen ) { + document.cancelFullScreen(); + } else if ( document.mozCancelFullScreen ) { + document.mozCancelFullScreen(); + } else if ( document.webkitCancelFullScreen ) { + document.webkitCancelFullScreen(); + } + } + + this.$fullscreen.detach(); + this.$wrapper.html( this.$main.detach() ); + } else { + this.$fullscreen = this.$fullscreen || $( '
' ) + .addClass( 'mlb-fullscreen-div' ); + + this.$fullscreen.html( this.$main.detach() ); + + this.$wrapper.append( this.$fullscreen ); + + fullscreen = this.$fullscreen[0]; + if ( fullscreen.requestFullScreen ) { + fullscreen.requestFullScreen(); + } else if ( fullscreen.mozRequestFullScreen ) { + fullscreen.mozRequestFullScreen(); + } else if ( fullscreen.webkitRequestFullScreen ) { + fullscreen.webkitRequestFullScreen(); + } + } + + this.isFullScreen = !this.isFullScreen; + }; + + LIP.load = function ( image ) { + var ele = image.getImageElement( function () { + iface.$image = $( ele ); + iface.$imageDiv.html( ele ); + image.autoResize( ele ); + + window.addEventListener( 'resize', function () { + image.autoResize( ele ); + } ); + + lightboxHooks.callAll( 'imageLoaded', iface ); + } ), + iface = this; + + this.currentImage = image; + }; + + LIP.setupPreDiv = function ( buildDefaults, toAdd ) { + if ( buildDefaults ) { + this.$controlBar = $( '
' ) + .addClass( 'mlb-controls' ); + + this.$closeButton = $( '
' ) + .text( ' ' ) + .addClass( 'mlb-close' ) + .click( this.unattach.bind( this ) ); + + this.$fullscreenButton = $( '
' ) + .text( ' ' ) + .addClass( 'mlb-fullscreen' ) + .click( function () { + this.fullscreenButtonJustPressed = true; + this.fullscreen(); + }.bind( this ) ); + + this.$controlBar.append( + this.$closeButton, + this.$fullscreenButton + ); + + this.$preDiv.append( this.$controlBar ); + + lightboxHooks.callAll( 'modifyDefaultPreDiv', this ); + } + + this.addElementsToDiv( this.$preDiv, toAdd ); + }; + + LIP.setupPostDiv = function ( buildDefaults, toAdd ) { + if ( buildDefaults ) { + lightboxHooks.callAll( 'modifyDefaultPostDiv', this ); + } + + this.addElementsToDiv( this.$postDiv, toAdd ); + }; + + LIP.addElementsToDiv = function ( $div, toAdd ) { + var i; + + for ( i = 0; i < toAdd.length; i++ ) { + $div.append( toAdd[i] ); + } + }; + + window.LightboxInterface = LightboxInterface; +}( jQuery ) ); diff --git a/js/multilightbox/multilightbox.js b/js/multilightbox/multilightbox.js new file mode 100644 index 000000000..7f3bd0634 --- /dev/null +++ b/js/multilightbox/multilightbox.js @@ -0,0 +1,135 @@ +( function ( $ ) { + var lightboxHooks, MLBP, HRP; + + /** + * @class + * @constructor + * @param {LightboxImage[]} images + * @param {number} [start=0] + */ + function MultiLightbox( images, start ) { + var lightbox = this; + + this.images = images; + this.currentIndex = start || 0; + this.onInterfaceReady = []; + + $( function () { + lightbox.iface = new LightboxInterface(); + lightbox.interfaceReady(); + } ); + } + + MLBP = MultiLightbox.prototype; + + MLBP.onInterface = function ( func ) { + if ( this.onInterfaceReady !== undefined ) { + this.onInterfaceReady.push( func ); + } else { + func(); + } + }; + + MLBP.interfaceReady = function () { + var i; + + for ( i = 0; i < this.onInterfaceReady.length; i++ ) { + this.onInterfaceReady[i](); + } + + this.onInterfaceReady = undefined; + }; + + MLBP.next = function () { + var result; + + if ( this.currentIndex >= this.images.length - 1 ) { + result = lightboxHooks.callAll( 'noNextImage', this ); + + if ( result === true ) { + return; + } + } + + result = lightboxHooks.callAll( 'nextImage', this ); + + if ( result === true ) { + this.iface.load( this.images[++this.currentIndex] ); + } + }; + + MLBP.prev = function () { + var result; + + if ( this.currentIndex <= 0 ) { + result = lightboxHooks.callAll( 'noPrevImage', this ); + + if ( result === true ) { + return; + } + } + + result = lightboxHooks.callAll( 'prevImage', this ); + + if ( result === true ) { + this.iface.load( this.images[--this.currentIndex] ); + } + }; + + MLBP.open = function () { + this.iface.attach(); + this.iface.load( this.images[this.currentIndex] ); + }; + + /** + * @class + * Simple hook registry + * @constructor + */ + function LightboxHookRegistry() { + this.hooks = {}; + } + + HRP = LightboxHookRegistry.prototype; + + /** + * Call all hooks of a type, with the provided arguments. + * @param {string} type + * @param {Mixed} thisArg + * @return {boolean} true if all hooks ran, false if one of them is overriding the default behaviour + */ + HRP.callAll = function ( type, thisArg ) { + var result, i, + hooks = this.hooks[type], + otherArgs = Array.prototype.slice.call( arguments, 2 ); + + if ( hooks !== undefined ) { + for ( i = 0; i < hooks.length; i++ ) { + result = hooks[i].apply( thisArg, otherArgs ); + if ( result === false ) { + return false; + } + } + } + + return true; + }; + + /** + * Register a hook of a type. + * @param {string} type + * @param {Function} hook + */ + HRP.register = function ( type, hook ) { + if ( this.hooks[type] === undefined ) { + this.hooks[type] = []; + } + + this.hooks[type].push( hook ); + }; + + lightboxHooks = new LightboxHookRegistry(); + + window.lightboxHooks = lightboxHooks; + window.MultiLightbox = MultiLightbox; +}( jQuery ) );