From 0ce1fcb4f05a27eec642a0a1a0f827391d52d805 Mon Sep 17 00:00:00 2001 From: Paul van Tilburg Date: Sun, 12 Sep 2010 13:56:24 +0200 Subject: [PATCH] Added application and source documentation. --- COPYING | 340 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README | 62 ++++++++++ TODO | 14 +++ plemp.rb | 137 ++++++++++++++++++---- 4 files changed, 534 insertions(+), 19 deletions(-) create mode 100644 COPYING create mode 100644 README create mode 100644 TODO diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..5b6e7c6 --- /dev/null +++ b/COPYING @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 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 Library 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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 Library General +Public License instead of this License. diff --git a/README b/README new file mode 100644 index 0000000..02aafac --- /dev/null +++ b/README @@ -0,0 +1,62 @@ += Plemp! + +Create your own online pile of junk! Plemp allows you to upload/put stuff +on a single canvas, for sharing, collaging or any purpose you can think of. + +== Features + +* Uploading of image/music/video/text files +* Adding content by means of pasting text +* Syntax highlighting of source code files +* (Re)arranging of the files +* Some visual effects for eye candy purposes +* Distributed management of the arrangement, i.e. everybody viewing the + Plemp page will (with some delay) see the same arrangement + +== Requirements + +Plemp! is an Camping application, so you need: + +* Ruby 1.8 (>= 1.8.6) or 1.9 (>= 1.9.1) +* Camping (>= 2.0) + * Active Record (>= 2.3) + * Markaby, and optionally: + * Mongrel + +The following Ruby librares are required: + +* CodeRay +* JSON +* MIME-Types + +and the following JavaScript libraries: + +* Prototype (>= 1.6) +* Script.aculo.us (>= 1.8) + +== Installation + +For now, Plemp! is in a developing state and not ready for site-wide +deployment yet. However, before running, make sure that prototype.js and +all JavaScript files from Script.aculo.us are available from public/ either +by copying or symlinking them there. + +== Usage + +Run from the command line: + + $ camping plemp.rb + +and head over to http://localhost:3301/ to view and use the Plemp! canvas. + +Files can be upload or text can be pasted using the Add/Upload Dialog +invoked by pressing the Plus key or the Plus button in the top-right +corner. Once uploaded, the objects can be arranged by dragging them +around. + +== License + +Plemp! 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. diff --git a/TODO b/TODO new file mode 100644 index 0000000..717c935 --- /dev/null +++ b/TODO @@ -0,0 +1,14 @@ +Plemp! ToDo +=========== + +* Comments +* Titles per object +* Drag&drop uploading +* Arbitrary file support +* Object features: + - Removal + - Metadata exposure + - Downloading of original version + - Resizing +* On hover bar showing the object features +* Working video support diff --git a/plemp.rb b/plemp.rb index 43e856b..9613ffc 100644 --- a/plemp.rb +++ b/plemp.rb @@ -1,3 +1,12 @@ +# plemp.rb - The Plemp! application, create your own on-line pile of junk! +# +# Plemp! is Copyright © 2010 Paul van Tilburg +# +# 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. + require "active_record" require "camping" require "coderay" @@ -9,7 +18,10 @@ require "pathname" Camping.goes :Plemp +# We want (somewhat) indent HTML to be produced. Markaby::Builder.set(:indent, 2) + +# Global variables. unless defined? BASE_DIR BASE_DIR = Pathname.new(__FILE__).dirname PUBLIC_DIR = BASE_DIR + "public" @@ -19,25 +31,35 @@ unless defined? BASE_DIR Version = "0.1" end +# = The Plemp module module Plemp + # Calls methods at application creation/setup time. def self.create Plemp::Models.create_schema end end +# = The Plemp models module Plemp::Models + # = The draggable model class + # + # This class represents an draggable object attached to an uploaded + # file. class Draggable < Base end + # = The basic fields class + # + # Class that connects model classes to database tables. class BasicFields < V 1.0 def self.up create_table Draggable.table_name do |d| d.string :file d.integer :left, :top, :z_index - # This gives us created_at and updated_at + # This gives us created_at and updated_at. d.timestamps end end @@ -46,18 +68,36 @@ module Plemp::Models drop_table Draggable.table_name end end -end +end # module Plemp::Models + +# = The Plemp controllers module Plemp::Controllers + # = The index controller + # + # Main controller that shows the canvas with the draggable objects. + # + # path:: / + # view:: Views#main class Index + # Retrieves all draggables and renders the main view. def get @draggables = Draggable.all render :main end end + # = The current controller + # + # Controller accessed through AJAX requests by the main page for getting + # the current (global) state (position) of the draggables. + # + # path:: /current + # view:: N/A class Current + # Retrieves all draggables with there top/left position and returns + # an Hash in JSON format. def get out = Hash.new Draggable.all.each { |d| out[d.file] = [d.left, d.top] } @@ -66,7 +106,40 @@ module Plemp::Controllers end end + # = The position save controller + # + # Controller used through AJAX request by the main page for committing + # position changes of the draggables to the database, i.e. the global + # state. + # + # path:: /savepos/// + # view:: N/A + class SaveposXXX + # Retrieves the draggable _file_ from the database and updates its + # _top_ and _left_ position. + def post(file, top, left) + [top, left].each { |pos| pos.gsub!(/px$/, '') } + $stderr.puts("Got: file id: #{file} -> top: #{top}, left: #{left}") + drag = Draggable.find_by_file(file) + drag.top = top + drag.left = left + drag.save + "" + end + end + + # = The static controller + # + # Controller to serve static data from either the public or upload + # subdirectory using X-Sendfile. + # + # path:: /static/(public,upload)/ + # view:: N/A (X-Sendfile) class StaticXX + # Determines the MIME type of the file referenced by _path_ and sets + # the suitable headers and X-Sendfile header. The _type_ can be either + # _public_ if the file came with Plemp!, or _upload_ if the file was + # once uploaded to Plemp!. def get(type, path) mime_type = MIME::Types.type_for(path).first @headers['Content-Type'] = mime_type.nil? ? "text/plain" : mime_type.to_s @@ -79,21 +152,24 @@ module Plemp::Controllers end end - class SaveposXXX - def post(file, top, left) - [top, left].each { |pos| pos.gsub!(/px$/, '') } - $stderr.puts("Got: file id: #{file} -> top: #{top}, left: #{left}") - drag = Draggable.find_by_file(file) - drag.top = top - drag.left = left - drag.save - "" - end - end - + # = The upload controller + # + # Controller to handle uploads from the main site. This can either + # be a file or some pasted text. After upload the controler redirects + # to the main page which includes the just uploaded file. + # + # path:: /upload + # redirect:: Index class Upload + # Creates a text file from input text or otherise from the supplied + # uploaded temp file. The file name is base on the current timestamp + # plus the appropriate extension. Also creates an Draggable object in + # the database. def post + # TODO: store the MIME type in the database! + # TODO: in case of text + filename, commit both. if @input.text.empty? + # Text input has priority over file uploads. orig_ext = File.extname(@input.file[:filename]).downcase file_base = Time.now.strftime("%Y%m%d%H%M%S#{orig_ext}") contents = @input.file[:tempfile].read @@ -111,10 +187,13 @@ module Plemp::Controllers end end -end +end # module Plemp::Controllers +# The Plemp views module Plemp::Views + # The main layout used by Controllers::*#render. Loads the appropriate + # style and JavaScript files. def layout xhtml_strict do head do @@ -129,12 +208,15 @@ module Plemp::Views "init_plemp();" end end + # TODO: move this to init_plemp()? body(:onLoad => "return setup_draggables();") do self << yield end end end + # The main view. Shows the header, the (hidden) add_dialog and the + # cavnas with the draggable objects. def main div.header! do h1 do @@ -142,6 +224,13 @@ module Plemp::Views div.add!(:onClick => "show_add_dialog(); return false;") { "+" } end end + add_dialog + draggables + end + + # The add dialog. A hidden dialog only shown when the Plus button/key + # is used. Uses Controllers::Upload to upload a file or pasted text. + def add_dialog div.add_dialog!(:style => "display:none;") do div.background {} form :action => R(Upload), :method => "post", :id => "add_form", @@ -160,18 +249,28 @@ module Plemp::Views end end end + end + + # The canvas with draggables. Creates a draggable HTML element including + # the actually contents of the associated file per Draggable object in + # the database. + def draggables div.draggables! do @draggables.each do |d| file = UPLOAD_DIR + d.file unless file.exist? + # The associated file of this Draggable object is gone, remove + # the object from the database too. d.destroy next end + # Determine the MIME type. file_type = `file --brief --mime-type #{file}`.chomp mime_type = MIME::Types[file_type].first if mime_type.nil? mime_type = MIME::Type.new(file_type) end + # Create an HTML element based on the type of the Draggable object. default_style = "left:#{d.left}px;top:#{d.top}px;z-index:0;display:none" case mime_type.media_type when "image" @@ -201,9 +300,9 @@ module Plemp::Views span.draggable :id => d.file, :style => default_style do em "#{d.file}: Unsupported file type!" end - end - end + end # case + end end - end + end # def draggables -end +end # module Plemp::Views