From 1af6ad00cf87516c6afcda71d93264c4670e78e0 Mon Sep 17 00:00:00 2001 From: Wouter R Date: Fri, 20 Dec 2013 15:18:03 +0100 Subject: [PATCH 1/3] Add license + copyright info on external software. Add script to add/replace license header in source files. --- LICENSE.txt | 339 ++++++++++++++++++++++++++++ NOTICE.txt | 6 + extra/license-headers/header-cstyle | 8 + extra/license-headers/header-lua | 8 + extra/license-headers/header-sh | 6 + extra/scripts/attach-license.lua | 261 +++++++++++++++++++++ license-spec.lua | 18 ++ 7 files changed, 646 insertions(+) create mode 100644 LICENSE.txt create mode 100644 NOTICE.txt create mode 100644 extra/license-headers/header-cstyle create mode 100644 extra/license-headers/header-lua create mode 100644 extra/license-headers/header-sh create mode 100755 extra/scripts/attach-license.lua create mode 100644 license-spec.lua diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE.txt @@ -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/NOTICE.txt b/NOTICE.txt new file mode 100644 index 0000000..218ce90 --- /dev/null +++ b/NOTICE.txt @@ -0,0 +1,6 @@ +Doodle3D uses the following external projects: + +Lua - Copyright (c) 1994–2013 Lua.org, PUC-Rio. - MIT license +Luafilesystem - Copyright (c) 2003 Kepler Project - MIT license +JSON.lua (http://regex.info/blog/lua/json) - Copyright (c) 2010-2013 Jeffrey Friedl - Creative Commons CC BY 3 license +urlcode.lua, part of CGILua - Copyright (c) 2003 Kepler Project - MIT license diff --git a/extra/license-headers/header-cstyle b/extra/license-headers/header-cstyle new file mode 100644 index 0000000..b70058d --- /dev/null +++ b/extra/license-headers/header-cstyle @@ -0,0 +1,8 @@ +/* + * This file is part of the Doodle3D project (http://doodle3d.com). + * + * Copyright (c) 2013, Doodle3D + * This software is licensed under the terms of the GNU GPL v2 or later. + * See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + */ + diff --git a/extra/license-headers/header-lua b/extra/license-headers/header-lua new file mode 100644 index 0000000..5f8fd31 --- /dev/null +++ b/extra/license-headers/header-lua @@ -0,0 +1,8 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + diff --git a/extra/license-headers/header-sh b/extra/license-headers/header-sh new file mode 100644 index 0000000..5de50b4 --- /dev/null +++ b/extra/license-headers/header-sh @@ -0,0 +1,6 @@ +# This file is part of the Doodle3D project (http://doodle3d.com). +# +# Copyright (c) 2013, Doodle3D +# This software is licensed under the terms of the GNU GPL v2 or later. +# See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + diff --git a/extra/scripts/attach-license.lua b/extra/scripts/attach-license.lua new file mode 100755 index 0000000..aff1024 --- /dev/null +++ b/extra/scripts/attach-license.lua @@ -0,0 +1,261 @@ +#!/usr/bin/env lua + +-- TODO: +-- - cstyle comments with lines in them not starting with a '*' are not detected properly +-- - cstyle comments a la '//' are ignored completely +-- - lua block comments are not recognized +-- - in replaceComments(), source files should only be replaced with temp file if it has actually been changed +local lfs = require('lfs') + +LICENSE_COMMENT_PREFIX = "This file is part of the Doodle3D project" + +local specs = nil +local headers = {} + + +local function getFileList(path) + local result = {} + if not path or type(path) ~= 'string' then return result end + for file in lfs.dir(path) do + --local fileWithSubPath = subPath and subPath..'/'..file or file + local subPath = path..'/'..file + if lfs.attributes(subPath,'mode') == 'file' then + table.insert(result, subPath) + elseif lfs.attributes(subPath,'mode')== 'directory' and file ~= '.' and file ~= '..' then + local rr = getFileList(subPath) + for _,v in ipairs(rr) do table.insert(result, v) end + end + end + + return result +end + +-- @returns indexed table with an entry for each line or nil if file could not be read +local function readFileAsLines(file) + local f,err = io.open(file, "r") + if not f then return f,err end + local result = {} + for l in f:lines() do + table.insert(result, l) + end + return result +end + +local function findItemInList(haystack, needle) + for _,v in pairs(haystack) do + if v == needle then return true end + end + return false +end + +local function getGitChangedFiles(path) + if not path then path = '' end + os.execute('git update-index -q --refresh') + local f,msg = io.popen('git diff-index --name-only HEAD -- ' .. path, "r") + if not f then return f,msg end + + local result = {} + for l in f:lines() do + table.insert(result, l) + end + + return result +end + +local function initHeaders(headersPath) +-- if not firmwareRootPath then firmwareRootPath = '.' end +-- local headersPath = firmwareRootPath .. '/' .. 'extra/license-headers' + print("Reading headers from: " .. headersPath) + headers['lua'] = readFileAsLines(headersPath .. '/header-lua') + headers['sh'] = readFileAsLines(headersPath .. '/header-sh') + headers['cstyle'] = readFileAsLines(headersPath .. '/header-cstyle') +end + +-- writes first through last lines from indexed string array 'lines' to f, with newlines in between +-- if last is nil, everything from first on will be written; if first is nil, it is considered to be line 1 +local function emitLines(lines, f, first, last) + if first == nil then first = 1 end + if last == nil then last = #lines end + if last - first < 0 then return end + for i=first, last do f:write(lines[i] .. '\n') end +end + +function string:hashbang() return self:find('^#!') and true or false end +function string:empty() return self:find('^[%s]*$') and true or false end + +function string:comment(filetype) + if filetype == 'lua' then return self:find('^%-%-.*') and true or false + elseif filetype == 'sh' then return self:find('^#.*') and true or false + elseif filetype == 'cstyle' then return self:find('^%s?/?%*.*') and true or false + end +end + + +-- @returns false if explicitly excluded, type (as string) if matched or nil otherwise +local function matchFileType(file) + local len = file:len() + for _,pat in ipairs(specs.EXCLUDE_FILES) do + local s,e = file:find(pat) + if s == 1 and e == len then return false end + end + + for pat,type in pairs(specs.PROCESS_FILES) do + local s,e = file:find(pat) + if s == 1 and e == len then return type end + end + + return nil +end + + +-- @returns first line nr or false if no comment found +-- @returns last line nr if comment found +local function findComment(lines, filetype) + if not (filetype == 'lua' or filetype == 'sh' or filetype == 'cstyle') then return nil,'unrecognized file type' end + + local first, last = false, nil + + local justConsumeEmpty = false + for i,l in ipairs(lines) do + if i > 1 and l:hashbang() then + break + elseif l:hashbang() then + --ignore this to simulate a continue + elseif not l:comment(filetype) then + if first and l:empty() then + justConsumeEmpty = true + elseif first then + last = i - 1 + break + elseif not l:empty() then + break + end + else + if justConsumeEmpty then + last = i - 1 + break + elseif not first then + first = i + end + end + end + + return first,last +end + + +local function detectLicenseComment(lines, filetype, first, last) + local hasText = function(line, filetype) + if filetype == 'lua' then return line:find('^[%s%-]*$') == nil and true or false + elseif filetype == 'sh' then return line:find('^[%s#]*$') == nil and true or false + elseif filetype == 'cstyle' then return line:find('^[%s%*/]*$') == nil and true or false + else return nil + end + end + + for i,l in ipairs(lines) do + if i >= first and i <= last and hasText(l, filetype) then + return l:find(LICENSE_COMMENT_PREFIX, 1, true) and true or false + end + end + + return false +end + + +-- replaces line range [first, last] with header for filetype +-- if first and/or last are nil, header is inserted at line 1, or 2 if a hashbang is present +-- returns true on success, nil+msg otherwise +local function replaceComment(filepath, filetype, lines, first, last) +-- local filesEqual = function(file1, file2) return os.execute('cmp -s ' .. file1 .. ' ' .. file2) end--and true or false end + + if first == nil or last == nil then first = lines[1]:hashbang() and 2 or 1 end + + local tmpFileName = os.tmpname() + f,msg = io.open(tmpFileName, "w+") + if not f then return f, "could not open temporary file '" .. tmpFileName .. "' (" .. msg .. ")" end + + emitLines(lines, f, 1, first - 1) + emitLines(headers[filetype], f) + emitLines(lines, f, last and last + 1 or first, nil) + + f:close() + +-- if not filesEqual(tmpFileName, filepath) then +-- print("actually replacing '" .. filepath .. "' with '" .. tmpFileName .. "' now...") + local rv,msg = os.rename(tmpFileName, filepath) + os.remove(tmpFileName) -- clean up + if not rv then return rv,"could not replace file with '" .. tmpFileName .. "' (" .. msg .. ")" end +-- else +-- print("files are equal, not touching original") +-- end + + return true +end + + +local function processFile(filepath, filetype, lines) + local sLine,eLine = findComment(lines, filetype) + if sLine then + if detectLicenseComment(lines, filetype, sLine, eLine) then + print("Replacing comment in file: '" .. filepath .. "' (type: " .. filetype .. ") head comment: " .. sLine .. "-" .. eLine) + replaceComment(filepath, filetype, lines, sLine, eLine) + else + print("Adding comment to file: '" .. filepath .. "' (type: " .. filetype .. ") unrecognized head comment: " .. sLine .. "-" .. eLine) + replaceComment(filepath, filetype, lines, nil, nil) + end + elseif sLine == false then + print("Adding comment to file: '" .. filepath .. "' (type: " .. filetype .. ") no comment") + replaceComment(filepath, filetype, lines, nil, nil) + else + return nil, "invalid type: '" .. filetype .. "'" + end + + return true +end + + +local function main() + if #arg ~= 1 then + print("Please supply directory containing 'license-spec.lua' as argument") + os.exit(1) + end + + local pwd = lfs.currentdir() + local scriptPath = arg[0]:match('^(.*)/') + local headersPath = pwd .. '/' .. scriptPath .. '/../license-headers' + initHeaders(headersPath) -- NOTE: this must be precede the chdir below + + print("Working directory: " .. arg[1]) + if not lfs.chdir(arg[1]) then + print("error: could not change to directory '" .. arg[1] .. "', exiting") + os.exit(1) + end + + specs = require('license-spec') + if not specs.BASE_PATH or specs.BASE_PATH:len() == 0 then specs.BASE_PATH = '.' end + + local files = getFileList(specs.BASE_PATH) + local changed = getGitChangedFiles(specs.BASE_PATH) +-- for _,l in ipairs(changed) do print("changed: " .. l) end --TEMP + + + for _,f in ipairs(files) do + local processType = matchFileType(f) + if processType then + if specs.IGNORE_GIT_CHANGED or not findItemInList(changed, f) then + local lines,err = readFileAsLines(f) + if lines then + local rv,msg = processFile(f, processType, lines) + if not rv then print("error: could not process file '" .. f .. "' (" .. msg .. ")") end + else + print("error: could not open '" .. f .. "' (".. err .. ")") + end + else + print("error: file '" .. f .. "' has uncommitted changes in git, refusing to process") + end + end + end +end + +main() diff --git a/license-spec.lua b/license-spec.lua new file mode 100644 index 0000000..3f451d5 --- /dev/null +++ b/license-spec.lua @@ -0,0 +1,18 @@ +local M = { + BASE_PATH = 'src', + EXCLUDE_FILES = { 'src/util/JSON.lua', 'src/util/urlcode.lua' }, + PROCESS_FILES = { + ['src/[^/]*%.lua'] = 'lua', + ['src/network/[^/]*%.lua'] = 'lua', + ['src/rest/[^/]*%.lua'] = 'lua', + ['src/rest/api/[^/]*%.lua'] = 'lua', + ['src/script/[^/]*%.lua'] = 'lua', + ['src/util/[^/]*%.lua'] = 'lua', + ['src/script/d3dapi'] = 'sh', + ['src/script/dhcpcheck_init'] = 'sh', + ['src/script/signin%.sh'] = 'sh', + ['src/script/wifibox_init'] = 'sh' + }, + IGNORE_GIT_CHANGED = false +} +return M From fc9460fc824f7acec87a895b775d0317cd1482f4 Mon Sep 17 00:00:00 2001 From: Wouter R Date: Fri, 20 Dec 2013 16:29:46 +0100 Subject: [PATCH 2/3] Add license header to source files. --- src/cmdmain.lua | 8 ++++++++ src/conf_defaults.lua | 8 ++++++++ src/main.lua | 8 ++++++++ src/network/netconfig.lua | 8 ++++++++ src/network/signin.lua | 8 ++++++++ src/network/wlanconfig.lua | 8 ++++++++ src/rest/api/api_config.lua | 8 ++++++++ src/rest/api/api_info.lua | 8 ++++++++ src/rest/api/api_network.lua | 8 ++++++++ src/rest/api/api_printer.lua | 8 ++++++++ src/rest/api/api_sketch.lua | 8 ++++++++ src/rest/api/api_system.lua | 8 ++++++++ src/rest/api/api_test.lua | 8 ++++++++ src/rest/api/api_update.lua | 8 ++++++++ src/rest/request.lua | 8 ++++++++ src/rest/response.lua | 8 ++++++++ src/script/d3d-updater.lua | 7 +++++++ src/script/d3dapi | 5 +++++ src/script/dhcpcheck_init | 5 +++++ src/script/signin.sh | 5 +++++ src/script/wifibox_init | 5 +++++ src/util/access.lua | 8 ++++++++ src/util/logger.lua | 8 ++++++++ src/util/printer.lua | 8 ++++++++ src/util/settings.lua | 8 ++++++++ src/util/status.lua | 8 ++++++++ src/util/utils.lua | 8 ++++++++ 27 files changed, 203 insertions(+) mode change 100755 => 100644 src/script/d3d-updater.lua mode change 100755 => 100644 src/script/d3dapi mode change 100755 => 100644 src/script/dhcpcheck_init mode change 100755 => 100644 src/script/signin.sh mode change 100755 => 100644 src/script/wifibox_init diff --git a/src/cmdmain.lua b/src/cmdmain.lua index eaa73e5..d681e5a 100644 --- a/src/cmdmain.lua +++ b/src/cmdmain.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + --- -- This file wraps @{main.handle_request} in main.lua for command-line or CGI usage. -- It emulates the env table usually constructed by uhttpd-mod-lua. diff --git a/src/conf_defaults.lua b/src/conf_defaults.lua index 0aabf44..31b1351 100644 --- a/src/conf_defaults.lua +++ b/src/conf_defaults.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + --- -- This file contains all valid configuration keys, their default values and optional constraints. -- The table names are used as configuration key names, where underscores ('`_`') may be used to denote semi-categories. diff --git a/src/main.lua b/src/main.lua index a92bed6..901a657 100644 --- a/src/main.lua +++ b/src/main.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + ---- -- Entry code of the REST API and secondary functionality. -- Primarily, this sets up the environment, processes a REST request and responds appropiately. diff --git a/src/network/netconfig.lua b/src/network/netconfig.lua index a126cd5..a3a1e8a 100644 --- a/src/network/netconfig.lua +++ b/src/network/netconfig.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local utils = require('util.utils') local log = require('util.logger') local settings = require('util.settings') diff --git a/src/network/signin.lua b/src/network/signin.lua index 0525d5b..0b78d4e 100644 --- a/src/network/signin.lua +++ b/src/network/signin.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + --- -- TODO: document local log = require('util.logger') diff --git a/src/network/wlanconfig.lua b/src/network/wlanconfig.lua index b089a86..f93564b 100644 --- a/src/network/wlanconfig.lua +++ b/src/network/wlanconfig.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local log = require('util.logger') local utils = require('util.utils') local uci = require('uci').cursor() diff --git a/src/rest/api/api_config.lua b/src/rest/api/api_config.lua index bdd0023..4c5518f 100644 --- a/src/rest/api/api_config.lua +++ b/src/rest/api/api_config.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local log = require('util.logger') local utils = require('util.utils') local settings = require('util.settings') diff --git a/src/rest/api/api_info.lua b/src/rest/api/api_info.lua index d4d9831..e1b7303 100644 --- a/src/rest/api/api_info.lua +++ b/src/rest/api/api_info.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local lfs = require('lfs') local log = require('util.logger') local utils = require('util.utils') diff --git a/src/rest/api/api_network.lua b/src/rest/api/api_network.lua index af5d1da..60158a7 100644 --- a/src/rest/api/api_network.lua +++ b/src/rest/api/api_network.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local log = require('util.logger') local settings = require('util.settings') local utils = require('util.utils') diff --git a/src/rest/api/api_printer.lua b/src/rest/api/api_printer.lua index d784ae9..8fc2407 100644 --- a/src/rest/api/api_printer.lua +++ b/src/rest/api/api_printer.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local lfs = require('lfs') local log = require('util.logger') local utils = require('util.utils') diff --git a/src/rest/api/api_sketch.lua b/src/rest/api/api_sketch.lua index b4ee73b..ad7c263 100644 --- a/src/rest/api/api_sketch.lua +++ b/src/rest/api/api_sketch.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + --[[ This module uses the Lua filesystem library to iterate over all sketches. A more flexible approach would be to use an index file (like the update module does). diff --git a/src/rest/api/api_system.lua b/src/rest/api/api_system.lua index 6a9d8de..8ebdb07 100644 --- a/src/rest/api/api_system.lua +++ b/src/rest/api/api_system.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local utils = require('util.utils') local M = { diff --git a/src/rest/api/api_test.lua b/src/rest/api/api_test.lua index 75c829c..e2466b8 100644 --- a/src/rest/api/api_test.lua +++ b/src/rest/api/api_test.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local l = require("util.logger") local ResponseClass = require("rest.response") diff --git a/src/rest/api/api_update.lua b/src/rest/api/api_update.lua index 37fccb0..60f5b56 100644 --- a/src/rest/api/api_update.lua +++ b/src/rest/api/api_update.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local wifi = require('network.wlanconfig') local netconf = require('network.netconfig') local settings = require('util.settings') diff --git a/src/rest/request.lua b/src/rest/request.lua index cc707bc..48d4773 100644 --- a/src/rest/request.lua +++ b/src/rest/request.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + --- -- This object represents an HTTP request object, part of the REST API. local util = require('util.utils') -- required for string:split() diff --git a/src/rest/response.lua b/src/rest/response.lua index ed5a16c..7e0660a 100644 --- a/src/rest/response.lua +++ b/src/rest/response.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + --- -- The REST response object handles all operations necessary to generate a HTTP response. -- It knows about the request, ensures the correct HTTP headers are present and diff --git a/src/script/d3d-updater.lua b/src/script/d3d-updater.lua old mode 100755 new mode 100644 index 6095c83..42bb48c --- a/src/script/d3d-updater.lua +++ b/src/script/d3d-updater.lua @@ -1,4 +1,11 @@ #!/usr/bin/env lua +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + --- This script provides an interface to upgrade or downgrade the Doodle3D wifibox. -- It can both be used as a standalone command-line tool and as a Lua library. diff --git a/src/script/d3dapi b/src/script/d3dapi old mode 100755 new mode 100644 index 3fdc06f..3dbe552 --- a/src/script/d3dapi +++ b/src/script/d3dapi @@ -1,4 +1,9 @@ #!/bin/sh +# This file is part of the Doodle3D project (http://doodle3d.com). +# +# Copyright (c) 2013, Doodle3D +# This software is licensed under the terms of the GNU GPL v2 or later. +# See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. # NOTE: redirection to $LOG_FILE is not required anymore, it is configurable now. # It is left in just as a precaution for a badly configured firmware invocation. diff --git a/src/script/dhcpcheck_init b/src/script/dhcpcheck_init old mode 100755 new mode 100644 index 11b05c5..2634c64 --- a/src/script/dhcpcheck_init +++ b/src/script/dhcpcheck_init @@ -1,4 +1,9 @@ #!/bin/sh /etc/rc.common +# This file is part of the Doodle3D project (http://doodle3d.com). +# +# Copyright (c) 2013, Doodle3D +# This software is licensed under the terms of the GNU GPL v2 or later. +# See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. # start after all other scripts START=99 diff --git a/src/script/signin.sh b/src/script/signin.sh old mode 100755 new mode 100644 index 7552f06..0ef2fa8 --- a/src/script/signin.sh +++ b/src/script/signin.sh @@ -1,4 +1,9 @@ #!/bin/sh +# This file is part of the Doodle3D project (http://doodle3d.com). +# +# Copyright (c) 2013, Doodle3D +# This software is licensed under the terms of the GNU GPL v2 or later. +# See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. sleep 5s while true; do diff --git a/src/script/wifibox_init b/src/script/wifibox_init old mode 100755 new mode 100644 index 81f9f81..cde12ea --- a/src/script/wifibox_init +++ b/src/script/wifibox_init @@ -1,4 +1,9 @@ #!/bin/sh /etc/rc.common +# This file is part of the Doodle3D project (http://doodle3d.com). +# +# Copyright (c) 2013, Doodle3D +# This software is licensed under the terms of the GNU GPL v2 or later. +# See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. # start after networking START=22 diff --git a/src/util/access.lua b/src/util/access.lua index f1858e9..ccb100b 100644 --- a/src/util/access.lua +++ b/src/util/access.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local log = require('util.logger') local utils = require('util.utils') diff --git a/src/util/logger.lua b/src/util/logger.lua index 6824337..e10072c 100644 --- a/src/util/logger.lua +++ b/src/util/logger.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + --- -- Logging facilities. diff --git a/src/util/printer.lua b/src/util/printer.lua index 5ff1f80..1c619eb 100644 --- a/src/util/printer.lua +++ b/src/util/printer.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local log = require('util.logger') local utils = require('util.utils') local printDriver = require('print3d') diff --git a/src/util/settings.lua b/src/util/settings.lua index 51bd8ca..c6f9a9b 100644 --- a/src/util/settings.lua +++ b/src/util/settings.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + --- -- The settings interface reads and writes configuration keys using [UCI](http://wiki.openwrt.org/doc/uci). -- All keys have pre-defined defaults in @{conf_defaults} which will be used diff --git a/src/util/status.lua b/src/util/status.lua index f2368a0..3f91736 100644 --- a/src/util/status.lua +++ b/src/util/status.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + local log = require('util.logger') local utils = require('util.utils') diff --git a/src/util/utils.lua b/src/util/utils.lua index 43c16b6..a6c3e37 100644 --- a/src/util/utils.lua +++ b/src/util/utils.lua @@ -1,3 +1,11 @@ +-- +-- This file is part of the Doodle3D project (http://doodle3d.com). +-- +-- @copyright 2013, Doodle3D +-- @license This software is licensed under the terms of the GNU GPL v2 or later. +-- See file LICENSE.txt or visit http://www.gnu.org/licenses/gpl.html for full license details. + + --- -- The unavoidable collection of utility functions. -- From d254beb1ab36d71fdb9fa02487ce6376f0942ba7 Mon Sep 17 00:00:00 2001 From: Wouter R Date: Fri, 20 Dec 2013 17:11:58 +0100 Subject: [PATCH 3/3] Do not generate error when printer device exists without accompanying server. Fixes https://github.com/Doodle3D/doodle3d-client/issues/139. --- src/rest/api/api_config.lua | 20 +++++++++----------- src/rest/api/api_network.lua | 6 ++---- src/rest/api/api_update.lua | 6 ++---- 3 files changed, 13 insertions(+), 19 deletions(-) diff --git a/src/rest/api/api_config.lua b/src/rest/api/api_config.lua index 4c5518f..9f90661 100644 --- a/src/rest/api/api_config.lua +++ b/src/rest/api/api_config.lua @@ -29,10 +29,8 @@ local function operationsAccessOrFail(request, response) end local rv, printerState = printerAPI.state(request, response, true) - if(rv == false) then - response:setError("Could not get printer state") - return false - end + -- NOTE: rv being false means a printer device exists but no server is running for it, so it cannot be 'busy' + if rv == false then return true end if printerState == 'buffering' or printerState == 'printing' or printerState == 'stopping' then response:setFail("Printer is busy, please wait") @@ -97,16 +95,16 @@ function M.all_GET(request, response) end --- Reset specific setting to default value --- When an setting has a subSection only the setting in it's current subSection is reset. --- For example you want to reset setting _printer.startcode_ --- and it has it's _subSection_ set to 'printer_type' --- and printer.type is set to 'ultimaker' then +-- When an setting has a subSection only the setting in it's current subSection is reset. +-- For example you want to reset setting _printer.startcode_ +-- and it has it's _subSection_ set to 'printer_type' +-- and printer.type is set to 'ultimaker' then -- only the printer.startcode under the ultimaker subsection is removed. function M.reset_POST(request, response) --log:info("API:reset"); if not operationsAccessOrFail(request, response) then return end response:setSuccess() - + for k,v in pairs(request:getAll()) do --log:info(" "..k..": "..v); local r,m = settings.reset(k); @@ -115,12 +113,12 @@ function M.reset_POST(request, response) end end ---- Reset all settings to default value +--- Reset all settings to default value function M.resetall_POST(request, response) if not operationsAccessOrFail(request, response) then return end response:setSuccess() settings.resetAll() - + for k,v in pairs(settings.getAll()) do response:addData(k,v) end diff --git a/src/rest/api/api_network.lua b/src/rest/api/api_network.lua index 60158a7..e29d1d5 100644 --- a/src/rest/api/api_network.lua +++ b/src/rest/api/api_network.lua @@ -29,10 +29,8 @@ local function operationsAccessOrFail(request, response) end local rv, printerState = printerAPI.state(request, response, true) - if(rv == false) then - response:setError("Could not get printer state") - return false - end + -- NOTE: rv being false means a printer device exists but no server is running for it, so it cannot be 'busy' + if rv == false then return true end if printerState == 'buffering' or printerState == 'printing' or printerState == 'stopping' then response:setFail("Printer is busy, please wait") diff --git a/src/rest/api/api_update.lua b/src/rest/api/api_update.lua index 60f5b56..e76e6bd 100644 --- a/src/rest/api/api_update.lua +++ b/src/rest/api/api_update.lua @@ -34,10 +34,8 @@ local function operationsAccessOrFail(request, response) end local rv, printerState = printerAPI.state(request, response, true) - if(rv == false) then - response:setError("Could not get printer state") - return false - end + -- NOTE: rv being false means a printer device exists but no server is running for it, so it cannot be 'busy' + if rv == false then return true end if printerState == 'buffering' or printerState == 'printing' or printerState == 'stopping' then response:setFail("Printer is busy, please wait")