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/Makefile b/Makefile index 402d8b5..63cdfae 100644 --- a/Makefile +++ b/Makefile @@ -16,7 +16,7 @@ IncludeWithNewlines = $(subst # Name and release number of this package PKG_NAME := wifibox PKG_VERSION := 0.1.1 -PKG_RELEASE := 7 +PKG_RELEASE := 8 # This specifies the directory where we're going to build the program. # The root build directory, $(BUILD_DIR), is by default the build_mipsel @@ -55,6 +55,7 @@ endef define Build/Prepare mkdir -p $(PKG_BUILD_DIR) $(CP) -r ./src/* $(PKG_BUILD_DIR)/ + $(CP) -r ./ReleaseNotes.md $(PKG_BUILD_DIR)/ endef define Build/Configure @@ -87,6 +88,7 @@ define Package/wifibox/install #$(INSTALL_DIR) $(1)/etc $(INSTALL_DIR) $(1)/etc/init.d $(INSTALL_DIR) $(1)/etc/config + #$(INSTALL_DIR) $(1)/www $(INSTALL_DIR) $(1)/www/cgi-bin ### create all files in /usr/share/lua/autowifi (autowifi) @@ -107,6 +109,10 @@ define Package/wifibox/install $(CP) $(WIFIBOX_BASE_DIR)/script/wifibox.uci.config $(1)/etc/config/wifibox # copy base configuration to uci config dir $(CP) $(WIFIBOX_BASE_DIR)/FIRMWARE-VERSION $(1)/etc/wifibox-version + + echo "
" > $(1)/www/ReleaseNotes.html
+	cat $(WIFIBOX_BASE_DIR)/ReleaseNotes.md >> $(1)/www/ReleaseNotes.html
+	echo "
" >> $(1)/www/ReleaseNotes.html ifeq ($(CONFIG_WIFIBOX_DEVEL_PACKAGE),y) # $(INSTALL_DIR) $(1)/$(TGT_LUA_DIR_SUFFIX)/test 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/ReleaseNotes.md b/ReleaseNotes.md index 9c308e3..c9d7579 100644 --- a/ReleaseNotes.md +++ b/ReleaseNotes.md @@ -1,3 +1,20 @@ +<<<<<<< HEAD +======= +# 0.9.13 (23th dec 2013) +- Links to release notes in settings update panel, both for current version and for updateable version. +- On finishing the tour the status message, thermometer and progress indicators are only hidden when appropriate +- Heated bed printer setting +- Gcode {if heatedBed} variable +- Enable / disable tour setting +- Displaying send percentage in status message +- Deltabot (Delta RostockMax, Deltamaker, Kossel) specific start- and endgcode +- Deltabot now have 0 x and y dimentions to center the print +- No more usb hub needed (OpenWRT full speed usb stability patch) +- You can now update without preserving your personal data (sketches / settings) +- Settings can be saved even if there are printer driver issues +- Save and restore settings issues fixed + +>>>>>>> develop # 0.9.12 (18th dec 2013): - Refill wifibox uci settings after reset, preventing printer driver crash (#138) 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/extra/scripts/release-wifibox-updates-dir.sh b/extra/scripts/release-wifibox-updates-dir.sh index 9ea4f18..8f2a1eb 100755 --- a/extra/scripts/release-wifibox-updates-dir.sh +++ b/extra/scripts/release-wifibox-updates-dir.sh @@ -41,7 +41,8 @@ if [ $RETURN_VALUE -ne 0 ]; then fi if [ $UPLOAD_FILES -eq 1 ]; then - UPLOAD_PATH=$BASE_URL:public_html/updates + #UPLOAD_PATH=$BASE_URL:public_html/updates + UPLOAD_PATH=$BASE_URL:doodle3d.com/DEFAULT/updates cat <<-'EOM' > $DEST_DIR/$UPDATES_DIR/.htaccess Options +Indexes 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 diff --git a/src/FIRMWARE-VERSION b/src/FIRMWARE-VERSION index 583b27a..981eaa4 100644 --- a/src/FIRMWARE-VERSION +++ b/src/FIRMWARE-VERSION @@ -1 +1,5 @@ +<<<<<<< HEAD 0.9.12 +======= +0.9.13 +>>>>>>> develop 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 fa015db..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. @@ -95,6 +103,9 @@ M.printer_type = { M.printer_dimensions_x = { default = 200, + default_delta_rostockmax = 0, + default_deltamaker = 0, + default_kossel = 0, subSection = 'printer_type', type = 'int', description = '', @@ -102,6 +113,9 @@ M.printer_dimensions_x = { } M.printer_dimensions_y = { default = 200, + default_delta_rostockmax = 0, + default_deltamaker = 0, + default_kossel = 0, subSection = 'printer_type', type = 'int', description = '', @@ -114,28 +128,44 @@ M.printer_dimensions_z = { description = '', min = 0 } +M.printer_heatedbed = { + default = false, + default_ultimaker2 = true, + default_makerbot_replicator2x = true, + subSection = 'printer_type', + type = 'bool', + description = 'Printer has heated bed', +} -local default_makerbot_startcode = '(**** CONFIGURATION MACROS ****)\n;@printer {printerType}\n;@enable progress\n(** This GCode was generated by ReplicatorG 0040 **)\n(* using Skeinforge (50) *)\n(* for a Dual headed Replicator 2 *)\n(* on 2013/10/27 15:07:27 (+0100) *)\n(**** start.gcode for Replicator 2X, single head ****)\nM103 (disable RPM)\nM73 P0 (enable build progress)\nG21 (set units to mm)\nG90 (set positioning to absolute)\nM104 S240 T0 (set extruder temperature) (temp updated by printOMatic)\nM140 S110 T0 (set HBP temperature)\n(**** begin homing ****)\nG162 X Y F2500 (home XY axes maximum)\nG161 Z F1100 (home Z axis minimum)\nG92 Z-5 (set Z to -5)\nG1 Z0.0 (move Z to "0")\nG161 Z F100 (home Z axis minimum)\nM132 X Y Z A B (Recall stored home offsets for XYZAB axis)\n(**** end homing ****)\nG1 X-141 Y-74 Z10 F3300.0 (move to waiting position)\nG130 X20 Y20 Z20 A20 B20 (Lower stepper Vrefs while heating)\nM6 T0 (wait for toolhead, and HBP to reach temperature)\nG130 X127 Y127 Z40 A127 B127 (Set Stepper motor Vref to defaults)\nM108 R3.0 T0\nG0 X-141 Y-74 (Position Nozzle)\nG0 Z0.6 (Position Height)\nM108 R5.0 (Set Extruder Speed)\nM101 (Start Extruder)\nG4 P2000 (Create Anchor)\nG92 X0 Y0\nM106\n(**** end of start.gcode ****)' +local default_makerbot_startcode = '(**** CONFIGURATION MACROS ****)\n;@printer {printerType}\n;@enable progress\n(** This GCode was generated by ReplicatorG 0040 **)\n(* using Skeinforge (50) *)\n(* for a Dual headed Replicator 2 *)\n(* on 2013/10/27 15:07:27 (+0100) *)\n(**** start.gcode for Replicator 2X, single head ****)\nM103 (disable RPM)\nM73 P0 (enable build progress)\nG21 (set units to mm)\nG90 (set positioning to absolute)\nM104 S240 T0 (set extruder temperature) (temp updated by printOMatic)\n{if heatedBed}M140 S110 T0 (set HBP temperature)\n(**** begin homing ****)\nG162 X Y F2500 (home XY axes maximum)\nG161 Z F1100 (home Z axis minimum)\nG92 Z-5 (set Z to -5)\nG1 Z0.0 (move Z to "0")\nG161 Z F100 (home Z axis minimum)\nM132 X Y Z A B (Recall stored home offsets for XYZAB axis)\n(**** end homing ****)\nG1 X-141 Y-74 Z10 F3300.0 (move to waiting position)\nG130 X20 Y20 Z20 A20 B20 (Lower stepper Vrefs while heating)\nM6 T0 (wait for toolhead, and HBP to reach temperature)\nG130 X127 Y127 Z40 A127 B127 (Set Stepper motor Vref to defaults)\nM108 R3.0 T0\nG0 X-141 Y-74 (Position Nozzle)\nG0 Z0.6 (Position Height)\nM108 R5.0 (Set Extruder Speed)\nM101 (Start Extruder)\nG4 P2000 (Create Anchor)\nG92 X0 Y0\nM106\n(**** end of start.gcode ****)' +local default_deltabot_startcode = ';Generated with Doodle3D (deltabot)\nM109 S{printingTemp} ;set target temperature\n{if heatedBed}M190 S{printingBedTemp} ;set target bed temperature\nG21 ;metric values\nG91 ;relative positioning\nM107 ;start with the fan off\nG28 ; move to home\nG92 E0 ;zero the extruded length\nG90 ;absolute positioning\nM117 Printing Doodle... ;display message (20 characters to clear whole screen)' M.printer_startcode = { - default = ';Generated with Doodle3D (default)\nM109 S{printingTemp} ;set target temperature \n;M190 S{printingBedTemp} ;set target bed temperature\nG21 ;metric values\nG91 ;relative positioning\nM107 ;start with the fan off\nG28 X0 Y0 ;move X/Y to min endstops\nG28 Z0 ;move Z to min endstops\nG1 Z15 F9000 ;move the platform down 15mm\nG92 E0 ;zero the extruded length\nG1 F200 E10 ;extrude 10mm of feed stock\nG92 E0 ;zero the extruded length again\nG92 E0 ;zero the extruded length again\nG1 F9000\nG90 ;absolute positioning\nM117 Printing Doodle... ;display message (20 characters to clear whole screen)', + default = ';Generated with Doodle3D (default)\nM109 S{printingTemp} ;set target temperature \n{if heatedBed}M190 S{printingBedTemp} ;set target bed temperature\nG21 ;metric values\nG91 ;relative positioning\nM107 ;start with the fan off\nG28 X0 Y0 ;move X/Y to min endstops\nG28 Z0 ;move Z to min endstops\nG1 Z15 F9000 ;move the platform down 15mm\nG92 E0 ;zero the extruded length\nG1 F200 E10 ;extrude 10mm of feed stock\nG92 E0 ;zero the extruded length again\nG92 E0 ;zero the extruded length again\nG1 F9000\nG90 ;absolute positioning\nM117 Printing Doodle... ;display message (20 characters to clear whole screen)', default_ultimaker2 = ';Generated with Doodle3D (ultimaker2)\nM109 S{printingTemp} ;set target temperature \nM190 S{printingBedTemp} ;set target bed temperature\nG21 ;metric values\nG90 ;absolute positioning\nM107 ;start with the fan off\nG28 ; home to endstops\nG1 Z15 F9000 ;move the platform down 15mm\nG92 E0 ;zero the extruded length\nG1 F200 E10 ;extrude 10mm of feed stock\nG92 E0 ;zero the extruded length again\nG1 F9000\nM117 Printing Doodle... ;display message (20 characters to clear whole screen)\n', default_makerbot_generic = default_makerbot_startcode, default_makerbot_replicator2 = default_makerbot_startcode, default_makerbot_replicator2x = default_makerbot_startcode, default_makerbot_thingomatic = default_makerbot_startcode, + default_delta_rostockmax = default_deltabot_startcode, + default_deltamaker = default_deltabot_startcode, + default_kossel = default_deltabot_startcode, type = 'string', subSection = 'printer_type', description = '' } local default_makerbot_endcode = '(******* End.gcode*******)\nM73 P100 ( End build progress )\nG0 Z150 ( Send Z axis to bottom of machine )\nM18 ( Disable steppers )\nM104 S0 T0 ( Cool down the Right Extruder )\nG162 X Y F2500 ( Home XY endstops )\nM18 ( Disable stepper motors )\nM70 P5 ( We <3 Making Things!)\nM72 P1 ( Play Ta-Da song )\n(*********end End.gcode*******)' +local default_deltabot_endcode = 'M107 ;fan offG91 ;relative positioningG1 E-1 F300 ;retract the filament a bit before lifting the nozzle, to release some of the pressureG1 Z+0.5 E-5 X-20 Y-20 F9000 ;move Z up a bit and retract filament even moreG28 ;move to homeM84 ;disable axes / steppersG90 ;absolute positioningM109 S0 ; hot end off{if heatedBed}M140 S{preheatBedTemp}M117 Done ;display message (20 characters to clear whole screen)' M.printer_endcode = { - default = 'M107 ;fan off\nG91 ;relative positioning\nG1 E-1 F300 ;retract the filament a bit before lifting the nozzle, to release some of the pressure\nG1 Z+0.5 E-5 X-20 Y-20 F9000 ;move Z up a bit and retract filament even more\nG28 X0 Y0 ;move X/Y to min endstops, so the head is out of the way\nM84 ;disable axes / steppers\nG90 ;absolute positioning\nM104 S{preheatTemp}\n;M140 S{preheatBedTemp}\nM117 Done ;display message (20 characters to clear whole screen)', + default = 'M107 ;fan off\nG91 ;relative positioning\nG1 E-1 F300 ;retract the filament a bit before lifting the nozzle, to release some of the pressure\nG1 Z+0.5 E-5 X-20 Y-20 F9000 ;move Z up a bit and retract filament even more\nG28 X0 Y0 ;move X/Y to min endstops, so the head is out of the way\nM84 ;disable axes / steppers\nG90 ;absolute positioning\nM104 S{preheatTemp}\n{if heatedBed}M140 S{preheatBedTemp}\nM117 Done ;display message (20 characters to clear whole screen)', default_ultimaker2 = 'M107 ;fan off\nG91 ;relative positioning\nG1 E-1 F300 ;retract the filament a bit before lifting the nozzle, to release some of the pressure\nG1 Z+5.5 E-5 X-20 Y-20 F9000 ;move Z up a bit and retract filament even more\nG28 ;home the printer\nM84 ;disable axes / steppers\nG90 ;absolute positioning\nM104 S{preheatTemp}\nM140 S{preheatBedTemp}\nM117 Done ;display message (20 characters to clear whole screen)', default_makerbot_generic = default_makerbot_endcode, default_makerbot_replicator2 = default_makerbot_endcode, default_makerbot_replicator2x = default_makerbot_endcode, default_makerbot_thingomatic = default_makerbot_endcode, + default_delta_rostockmax = default_deltabot_endcode, + default_deltamaker = default_deltabot_endcode, + default_kossel = default_deltabot_endcode, type = 'string', subSection = 'printer_type', description = '' @@ -283,4 +313,10 @@ M.doodle3d_simplify_minDistance = { min = 0 } +M.doodle3d_tour_enabled = { + default = true, + type = 'bool', + description = 'Show tour to new users' +} + return M diff --git a/src/main.lua b/src/main.lua index 7649424..c5252b2 100644 --- a/src/main.lua +++ b/src/main.lua @@ -1,4 +1,12 @@ ---- +-- +-- 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. -- Secondary functions are to auto-switch between access point and client (@{setupAutoWifiMode}) @@ -15,6 +23,12 @@ local RequestClass = require('rest.request') local ResponseClass = require('rest.response') local Signin = require('network.signin') +-- NOTE: the updater module 'detects' command-line invocation by existence of 'arg', so we have to make sure it is not defined. +argStash = arg +arg = nil +local updater = require('script.d3d-updater') +arg = argStash + local postData = nil @@ -118,6 +132,12 @@ local function setupLogger() else logTargetError = msg end end + else + -- if uci config not available, fallback to /tmp/wifibox.log + local f,msg = io.open('/tmp/wifibox.log', 'a+') + if f then logStream = f + else logTargetError = msg + end end if type(logLevelSetting) == 'string' and logLevelSetting:len() > 0 then @@ -185,6 +205,10 @@ local function main(environment) local rq = RequestClass.new(environment, postData, confDefaults.DEBUG_API) if rq:getRequestMethod() == 'CMDLINE' and rq:get('autowifi') ~= nil then + + local version = updater.formatVersion(updater.getCurrentVersion()); + log:info("Doodle3D version: "..util.dump(version)) + log:info("running in autowifi mode") local rv,msg = setupAutoWifiMode() 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..00d8be1 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') @@ -21,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") @@ -40,8 +46,12 @@ function M._global_GET(request, response) for k,v in pairs(request:getAll()) do local r,m = settings.get(k) - if r ~= nil then response:addData(k, r) - else response:addData(k, "could not read key ('" .. m .. "')") + if r ~= nil then + response:addData(k, r) + else + response:addData(k, "could not read key ('" .. m .. "')") + response:setError(m) + return end end end @@ -56,23 +66,26 @@ function M._global_POST(request, response) local validation = {} for k,v in pairs(request:getAll()) do --log:info(" "..k..": "..v); - local r,m = settings.set(k, v) + local r,m = settings.set(k, v, true) if r then - --response:addData(k, "ok") validation[k] = "ok" - else - --response:addData(k, "could not save setting ('" .. m .. "')") + elseif r == false then validation[k] = "could not save setting ('" .. m .. "')" log:info(" m: "..utils.dump(m)) + elseif r == nil then + settings.commit() + response:setError(m) + return end end + settings.commit() response:addData("validation",validation) local substitutedSsid = wifi.getSubstitutedSsid(settings.get('network.ap.ssid')) response:addData("substituted_ssid",substitutedSsid) - -- we now call signin seperatly trough cgi-bin + -- we now call signin seperately trough cgi-bin --[[log:info("API:Network:try signing in") if signin.signin() then log:info("API:Network:signin successfull") @@ -82,37 +95,54 @@ function M._global_POST(request, response) end function M.all_GET(request, response) - response:setSuccess() - for k,v in pairs(settings.getAll()) do - response:addData(k,v) + local allSettings, msg = settings.getAll(); + if allSettings then + response:setSuccess() + for k,v in pairs(settings.getAll()) do + response:addData(k,v) + end + else + response:setError(msg) + return end 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); - if r ~= nil then response:addData(k, "ok") - else response:addData(k, "could not reset key ('" .. m .. "')") end + if r ~= nil then + response:addData(k, "ok") + else + response:addData(k, "could not reset key ('" .. m .. "')") + response:setError(m) + return + end 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() - + + local rv, msg = settings.resetAll() + + if(rv == nil) then + response:setError(msg) + return + end + for k,v in pairs(settings.getAll()) do response:addData(k,v) end 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..e29d1d5 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') @@ -21,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_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..ffd378c 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') @@ -26,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") @@ -145,10 +151,11 @@ end function M.install_POST(request, response) local argVersion = request:get("version") local argNoRetain = request:get("no_retain") - log:info("API:update/install") - + log:info("API:update/install (noRetain: "..utils.dump(argNoRetain)..")") + local noRetain = argNoRetain == 'true' + if not operationsAccessOrFail(request, response) then return end - + updater.setLogger(log) updater.setState(updater.STATE.INSTALLING,"") @@ -177,7 +184,7 @@ function M.install_POST(request, response) return end - local rv,msg = updater.flashImageVersion(vEnt, argNoRetain) + local rv,msg = updater.flashImageVersion(vEnt, noRetain) if not rv then updater.setState(updater.STATE.INSTALL_FAILED, "installation failed (" .. msg .. ")") 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 72e8474..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 @@ -5,7 +13,9 @@ local JSON = require('util/JSON') local settings = require('util.settings') local defaults = require('conf_defaults') - +local utils = require('util.utils') +local log = require('util.logger') + local M = {} M.__index = M @@ -121,8 +131,6 @@ end --- Call all function on the post-response queue, see @{M:addPostResponseFunction} for details and a side-note. function M:executePostResponseQueue() - --local utils = require('util.utils') - --local log = require('util.logger') --log:info("Response:executePostResponseQueue: " .. utils.dump(self.postResponseQueue)) for i,fn in ipairs(self.postResponseQueue) do fn() end @@ -159,6 +167,10 @@ function M:send() io.write("\r\n") io.write(self.binaryData) end + + if self.body.status ~= "success" then + log:debug("Response:"..utils.dump(self.body.status).." ("..utils.dump(self.body.msg)..")") + end end --- Sets the response object to return binary data instead of JSON as its body. 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..353dede 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 @@ -148,24 +156,32 @@ end]]-- --- Returns the value of the requested key if it exists. -- @p key The key to return the associated value for. --- @return The associated value, beware (!) that this may be boolean false for keys of 'bool' type. +-- @return The associated value, beware (!) that this may be boolean false for keys of 'bool' type, or nil if the key could not be read because of a UCI error. +-- @treturn string Message in case of error. function M.get(key) --log:info("settings:get: "..utils.dump(key)) key = replaceDots(key) local base = getBaseKeyTable(key) if not base then return nil,ERR_NO_SUCH_KEY end - + local section = UCI_CONFIG_SECTION; - if base.subSection ~= nil then + if base.subSection ~= nil then section = M.get(base.subSection) end - - local uciV = fromUciValue(uci:get(UCI_CONFIG_NAME, section, key), base.type) + + local uciV,msg = uci:get(UCI_CONFIG_NAME, section, key) + if not uciV and msg ~= nil then + local errorMSG = "Issue reading setting '"..utils.dump(key).."': "..utils.dump(msg); + log:info(errorMSG) + return nil, errorMSG; + end + + local uciV = fromUciValue(uciV, base.type) if uciV ~= nil then - -- returning value from uci + -- returning value from uci return uciV - elseif base.subSection ~= nil then + elseif base.subSection ~= nil then local subDefault = base["default_"..section] if subDefault ~= nil then -- returning subsection default value @@ -177,13 +193,19 @@ function M.get(key) end --- Returns all configuration keys with their current values. --- @treturn table A table containing a key/value pair for each configuration key. +-- @return A table containing a key/value pair for each configuration key, or nil if a UCI error occured. +-- @return string Message in case of error. function M.getAll() local result = {} for k,_ in pairs(baseconfig) do if not k:match('^[A-Z_]*$') then --TEMP: skip 'constants', which should be moved anyway local key = replaceUnderscores(k) - result[key] = M.get(key) + local v, msg = M.get(key) + if not v and msg ~= nil then + return nil, msg + else + result[key] = v + end end end return result @@ -213,18 +235,33 @@ end --- Sets a key to a new value or reverts it to the default value. -- @string key The key to set. -- @p[opt=nil] value The value or set, or nil to revert key to its default value. --- @treturn bool|nil True if everything went well, nil in case of error. +-- @p[opt=nil] noCommit If true, do not commit the uci configuration; this is more efficient when setting multiple values +-- @treturn bool|nil True if everything went well, false if validation error, nil in case of error. -- @treturn ?string Error message in case first return value is nil (invalid key). +<<<<<<< HEAD function M.set(key, value) +======= +function M.set(key, value, noCommit) +>>>>>>> develop log:info("settings:set: "..utils.dump(key).." to: "..utils.dump(value)) key = replaceDots(key) local r = utils.create(UCI_CONFIG_FILE) - uci:set(UCI_CONFIG_NAME, UCI_CONFIG_SECTION, UCI_CONFIG_TYPE) + local rv, msg = uci:set(UCI_CONFIG_NAME, UCI_CONFIG_SECTION, UCI_CONFIG_TYPE) + if not rv and msg ~= nil then + local errorMSG = "Issue creating section '"..utils.dump(UCI_CONFIG_SECTION).."': "..utils.dump(msg); + log:info(errorMSG) + return nil, errorMSG; + end local base = getBaseKeyTable(key) +<<<<<<< HEAD if not base then return nil,ERR_NO_SUCH_KEY end +======= + if not base then return false,ERR_NO_SUCH_KEY end + +>>>>>>> develop --log:info(" base.type: "..utils.dump(base.type)) if base.type == 'bool' then if value ~= "" then @@ -235,38 +272,59 @@ function M.set(key, value) elseif base.type == 'int' or base.type == 'float' then value = tonumber(value) if(value == nil) then - return nil,"Value isn't a valid int or float" + return false,"Value isn't a valid int or float" end end - - + local valid,m = isValid(value, base) if not valid then - return nil,m + return false,m end local section = UCI_CONFIG_SECTION; - if base.subSection ~= nil then + if base.subSection ~= nil then section = M.get(base.subSection) - uci:set(UCI_CONFIG_NAME, section, UCI_CONFIG_TYPE) + local rv, msg = uci:set(UCI_CONFIG_NAME, section, UCI_CONFIG_TYPE) + if not rv and msg ~= nil then + local errorMSG = "Issue getting subsection '"..utils.dump(base.subSection).."': "..utils.dump(msg); + log:info(errorMSG) + return nil, errorMSG; + end end if value ~= nil then - uci:set(UCI_CONFIG_NAME, section, key, toUciValue(value, base.type)) + local rv, msg = uci:set(UCI_CONFIG_NAME, section, key, toUciValue(value, base.type)) + if not rv and msg ~= nil then + local errorMSG = "Issue setting setting '"..utils.dump(key).."' in section '"..utils.dump(section).."': "..utils.dump(msg); + log:info(errorMSG) + return nil, errorMSG; + end else - uci:delete(UCI_CONFIG_NAME, section, key) + local rv, msg = uci:delete(UCI_CONFIG_NAME, section, key) + if not rv and msg ~= nil then + local errorMSG = "Issue deleting setting '"..utils.dump(key).."' in section '"..utils.dump(section).."': "..utils.dump(msg); + log:info(errorMSG) + return nil, errorMSG; + end end - uci:commit(UCI_CONFIG_NAME) + if noCommit ~= true then uci:commit(UCI_CONFIG_NAME) end return true end ---- Reset all settings to their default values +--- Commit the UCI configuration, this can be used after making multiple changes +-- which have not been committed yet. +function M.commit() + uci:commit(UCI_CONFIG_NAME) +end + +--- Reset all settings to their default values -- @string key The key to set. -- @treturn bool|nil True if everything went well, nil in case of error. function M.resetAll() log:info("settings:resetAll") +<<<<<<< HEAD -- delete all uci sections but system local allSections = uci:get_all(UCI_CONFIG_NAME) for key,value in pairs(allSections) do @@ -284,23 +342,60 @@ function M.resetAll() end uci:commit(UCI_CONFIG_NAME) +======= + -- find all sections + local allSections, msg = uci:get_all(UCI_CONFIG_NAME) + if not allSections and msg ~= nil then + local errorMSG = "Issue reading all settings: "..utils.dump(msg); + log:info(errorMSG) + return nil, errorMSG; + end + -- delete all uci sections but system + for key,value in pairs(allSections) do + if key ~= "system" and not key:match('^[A-Z_]*$') then --TEMP: skip 'constants', which should be moved anyway + local rv, msg = uci:delete(UCI_CONFIG_NAME,key) + if not rv and msg ~= nil then + local errorMSG = "Issue deleting setting '"..utils.dump(key).."': "..utils.dump(msg); + log:info(errorMSG) + return nil, errorMSG; + end + end + end + + -- reset all to defaults + for k,_ in pairs(baseconfig) do + if not k:match('^[A-Z_]*$') then --TEMP: skip 'constants', which should be moved anyway + M.reset(k,true) + end + end +>>>>>>> develop + + M.commit() return true end ---- Reset setting to default value +--- Reset setting to default value -- @string key The key to reset. +-- @p[opt=nil] noCommit If true, do not commit the uci configuration; this is more efficient when resetting multiple values -- @treturn bool|nil True if everything went well, nil in case of error. +<<<<<<< HEAD function M.reset(key) log:info("settings:reset: "..utils.dump(key)) +======= +function M.reset(key, noCommit) + log:info("settings:reset: "..utils.dump(key)) + +>>>>>>> develop -- delete key = replaceDots(key) local base = getBaseKeyTable(key) if not base then return nil,ERR_NO_SUCH_KEY end local section = UCI_CONFIG_SECTION; - if base.subSection ~= nil then + if base.subSection ~= nil then section = M.get(base.subSection) +<<<<<<< HEAD end uci:delete(UCI_CONFIG_NAME, section, key) @@ -308,16 +403,37 @@ function M.reset(key) M.set(key,M.get(key)) uci:commit(UCI_CONFIG_NAME) +======= + end + local rv, msg = uci:delete(UCI_CONFIG_NAME, section, key) + -- we can't respond to errors in general here because when a key isn't found + -- (which always happens when reset is used in resetall) it will also generate a error + --if not rv and msg ~= nil then + -- local errorMSG = "Issue deleting setting '"..utils.dump(key).."' in section '"..section.."': "..utils.dump(msg); + -- log:info(errorMSG) + -- return nil, errorMSG; + --end + + -- reuse get logic to retrieve default and set it. + M.set(key,M.get(key),true) + + if noCommit ~= true then uci:commit(UCI_CONFIG_NAME) end +>>>>>>> develop return true end --- Returns a UCI configuration key from the system section. -- @string key The key for which to return the value, must be non-empty. --- @return Requested value or false if it does not exist or nil on invalid key. +-- @return Requested value or false if it does not exist or nil on UCI error. function M.getSystemKey(key) if type(key) ~= 'string' or key:len() == 0 then return nil end - local v = uci:get(UCI_CONFIG_NAME, UCI_CONFIG_SYSTEM_SECTION, key) + local v,msg = uci:get(UCI_CONFIG_NAME, UCI_CONFIG_SYSTEM_SECTION, key) + if not v and msg ~= nil then + local errorMSG = "Issue getting system setting '"..utils.dump(key).."' in section '"..UCI_CONFIG_SYSTEM_SECTION.."': "..utils.dump(msg); + return nil, errorMSG; + end + return v or false end 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. --