From 419741d7ebac1843a66aa3bab17946f07eb6938e Mon Sep 17 00:00:00 2001 From: Umberto Baldi Date: Tue, 8 Nov 2022 18:06:06 +0100 Subject: [PATCH 1/9] remove `embedded_autoextract`, it has never been used --- main.go | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/main.go b/main.go index df33dc7c1..c46c2b758 100755 --- a/main.go +++ b/main.go @@ -36,7 +36,6 @@ import ( "github.com/arduino/arduino-create-agent/systray" "github.com/arduino/arduino-create-agent/tools" "github.com/arduino/arduino-create-agent/updater" - "github.com/arduino/arduino-create-agent/utilities" v2 "github.com/arduino/arduino-create-agent/v2" "github.com/gin-gonic/gin" "github.com/go-ini/ini" @@ -47,7 +46,6 @@ import ( var ( version = "x.x.x-dev" //don't modify it, Jenkins will take care commit = "xxxxxxxx" //don't modify it, Jenkins will take care - embeddedAutoextract = false port string portSSL string requiredToolsAPILevel = "v1" @@ -186,15 +184,6 @@ func loop() { src, _ := os.Executable() dest := filepath.Dir(src) - if embeddedAutoextract { - // save the config.ini (if it exists) - if _, err := os.Stat(filepath.Join(dest, "config.ini")); os.IsNotExist(err) { - log.Println("First run, unzipping self") - err := utilities.Unzip(src, dest) - log.Println("Self extraction, err:", err) - } - } - // Parse ini config args, err := parseIni(filepath.Join(dest, "config.ini")) if err != nil { From 46aebbfe361bce6aa31135d901fabb56ac539d35 Mon Sep 17 00:00:00 2001 From: Umberto Baldi Date: Wed, 9 Nov 2022 16:16:51 +0100 Subject: [PATCH 2/9] rework `config.ini` searching By default the config.ini should be searched in the same directory of the binary. If it's not found maybe could be in the parent of the binary, inside `Resources/` (we are on macos). Added also some logging. Use `go-paths-helper` to ease things. --- .../arduino/go-paths-helper.dep.yml | 350 ++++++++++++++++++ main.go | 50 ++- 2 files changed, 384 insertions(+), 16 deletions(-) create mode 100644 .licenses/arduino-create-agent/go/github.com/arduino/go-paths-helper.dep.yml diff --git a/.licenses/arduino-create-agent/go/github.com/arduino/go-paths-helper.dep.yml b/.licenses/arduino-create-agent/go/github.com/arduino/go-paths-helper.dep.yml new file mode 100644 index 000000000..a7dd692a0 --- /dev/null +++ b/.licenses/arduino-create-agent/go/github.com/arduino/go-paths-helper.dep.yml @@ -0,0 +1,350 @@ +--- +name: github.com/arduino/go-paths-helper +version: v1.8.0 +type: go +summary: +homepage: https://pkg.go.dev/github.com/arduino/go-paths-helper +license: gpl-2.0-or-later +licenses: +- sources: LICENSE + text: |2 + 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. +notices: [] diff --git a/main.go b/main.go index c46c2b758..30d0316fb 100755 --- a/main.go +++ b/main.go @@ -37,6 +37,7 @@ import ( "github.com/arduino/arduino-create-agent/tools" "github.com/arduino/arduino-create-agent/updater" v2 "github.com/arduino/arduino-create-agent/v2" + paths "github.com/arduino/go-paths-helper" "github.com/gin-gonic/gin" "github.com/go-ini/ini" log "github.com/sirupsen/logrus" @@ -180,28 +181,45 @@ func loop() { if *hibernate { return } - // autoextract self + src, _ := os.Executable() - dest := filepath.Dir(src) + srcPath := paths.New(src) + srcDir := srcPath.Parent() + log.Print(srcPath) + log.Print(srcDir) + + configPath := srcDir.Join("config.ini") + log.Print(configPath) + + if configPath.NotExist() { + // probably we are on macOS, where the config is in a different dir + configPath = srcDir.Parent().Join("Resources", "config.ini") + if configPath.NotExist() { + log.Panic("config.ini file not found") + } + } - // Parse ini config - args, err := parseIni(filepath.Join(dest, "config.ini")) + // Parse default ini config + args, err := parseIni(configPath.String()) if err != nil { - panic(err) + log.Panicf("config.ini cannot be parsed: %s", err) } err = iniConf.Parse(args) if err != nil { - panic(err) + log.Panicf("cannot parse arguments: %s", err) } - // Parse additional ini config - args, err = parseIni(filepath.Join(dest, *additionalConfig)) - if err != nil { - panic(err) - } - err = iniConf.Parse(args) - if err != nil { - panic(err) + // Parse additional ini config if defined + if len(*additionalConfig) > 0 { + log.Print(*additionalConfig) + args, err = parseIni(srcDir.Join(*additionalConfig).String()) + if err != nil { + log.Panicf("additional config.ini cannot be parsed: %s", err) + } + err = iniConf.Parse(args) + if err != nil { + log.Panicf("cannot parse arguments: %s", err) + } } // Instantiate Tools @@ -371,7 +389,7 @@ func loop() { go func() { // check if certificates exist; if not, use plain http - if _, err := os.Stat(filepath.Join(dest, "cert.pem")); os.IsNotExist(err) { + if srcDir.Join("cert.pem").NotExist() { log.Error("Could not find HTTPS certificate. Using plain HTTP only.") return } @@ -382,7 +400,7 @@ func loop() { for i < end { i = i + 1 portSSL = ":" + strconv.Itoa(i) - if err := r.RunTLS(*address+portSSL, filepath.Join(dest, "cert.pem"), filepath.Join(dest, "key.pem")); err != nil { + if err := r.RunTLS(*address+portSSL, srcDir.Join("cert.pem").String(), srcDir.Join("key.pem").String()); err != nil { log.Printf("Error trying to bind to port: %v, so exiting...", err) continue } else { From e8b148ea6ba9382ea1ce644f38e723f72c3e52b2 Mon Sep 17 00:00:00 2001 From: Umberto Baldi Date: Thu, 10 Nov 2022 15:26:05 +0100 Subject: [PATCH 3/9] fine-tune a config searching and parsing --- main.go | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/main.go b/main.go index 30d0316fb..dcec75aa0 100755 --- a/main.go +++ b/main.go @@ -185,17 +185,14 @@ func loop() { src, _ := os.Executable() srcPath := paths.New(src) srcDir := srcPath.Parent() - log.Print(srcPath) - log.Print(srcDir) configPath := srcDir.Join("config.ini") - log.Print(configPath) if configPath.NotExist() { // probably we are on macOS, where the config is in a different dir configPath = srcDir.Parent().Join("Resources", "config.ini") if configPath.NotExist() { - log.Panic("config.ini file not found") + log.Panicf("config.ini file not found in %s", configPath) } } @@ -208,17 +205,23 @@ func loop() { if err != nil { log.Panicf("cannot parse arguments: %s", err) } + log.Infof("using config from %s", configPath) // Parse additional ini config if defined if len(*additionalConfig) > 0 { - log.Print(*additionalConfig) - args, err = parseIni(srcDir.Join(*additionalConfig).String()) - if err != nil { - log.Panicf("additional config.ini cannot be parsed: %s", err) - } - err = iniConf.Parse(args) - if err != nil { - log.Panicf("cannot parse arguments: %s", err) + additionalConfigPath := paths.New(*additionalConfig) + if additionalConfigPath.NotExist() { + log.Infof("additional config file not found in %s", additionalConfigPath.String()) + } else { + args, err = parseIni(additionalConfigPath.String()) + if err != nil { + log.Panicf("additional config cannot be parsed: %s", err) + } + err = iniConf.Parse(args) + if err != nil { + log.Panicf("cannot parse arguments: %s", err) + } + log.Infof("using additional config from %s", additionalConfigPath.String()) } } From 7ab173623d72656606b97b7d481db74607a63224 Mon Sep 17 00:00:00 2001 From: Umberto Baldi Date: Thu, 10 Nov 2022 16:43:44 +0100 Subject: [PATCH 4/9] enable `ARDUINO_CREATE_AGENT_CONFIG` env var to specify the config.ini --- main.go | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/main.go b/main.go index dcec75aa0..aad62e5bd 100755 --- a/main.go +++ b/main.go @@ -186,13 +186,25 @@ func loop() { srcPath := paths.New(src) srcDir := srcPath.Parent() - configPath := srcDir.Join("config.ini") + var configPath *paths.Path - if configPath.NotExist() { - // probably we are on macOS, where the config is in a different dir - configPath = srcDir.Parent().Join("Resources", "config.ini") + // see if the env var is defined, if it is take the config from there + envConfig := os.Getenv("ARDUINO_CREATE_AGENT_CONFIG") + if envConfig != "" { + configPath = paths.New(envConfig) if configPath.NotExist() { - log.Panicf("config.ini file not found in %s", configPath) + log.Panicf("config from env var %s does not exists", envConfig) + } + } else { + // take the config from the folder where the binary sits + configPath = srcDir.Join("config.ini") + + if configPath.NotExist() { + // probably we are on macOS, where the config is in a different dir + configPath = srcDir.Parent().Join("Resources", "config.ini") + if configPath.NotExist() { + log.Panicf("config.ini file not found in %s", configPath) + } } } From 8518826138bdbce5ce4ad6fef303ad017847bab4 Mon Sep 17 00:00:00 2001 From: umbynos Date: Mon, 21 Nov 2022 16:30:19 +0100 Subject: [PATCH 5/9] crashreports are now created in `.arduino-create/logs` to preserve macos bundle integrity --- main.go | 20 ++++++++------------ systray/systray_real.go | 35 +++++++++++++++++------------------ 2 files changed, 25 insertions(+), 30 deletions(-) diff --git a/main.go b/main.go index aad62e5bd..fc5199e70 100755 --- a/main.go +++ b/main.go @@ -24,7 +24,6 @@ import ( "io/ioutil" "os" "os/user" - "path/filepath" "runtime" "runtime/debug" "strconv" @@ -239,9 +238,10 @@ func loop() { // Instantiate Tools usr, _ := user.Current() - directory := filepath.Join(usr.HomeDir, ".arduino-create") + usrDir := paths.New(usr.HomeDir) + agentDir := usrDir.Join(".arduino-create") Tools = tools.Tools{ - Directory: directory, + Directory: agentDir.String(), IndexURL: *indexURL, Logger: func(msg string) { mapD := map[string]string{"DownloadStatus": "Pending", "Msg": msg} @@ -331,16 +331,12 @@ func loop() { // save crashreport to file if *crashreport { logFilename := "crashreport_" + time.Now().Format("20060102150405") + ".log" - currDir, err := os.Getwd() - if err != nil { - panic(err) - } // handle logs directory creation - logsDir := filepath.Join(currDir, "logs") - if _, err := os.Stat(logsDir); os.IsNotExist(err) { - os.Mkdir(logsDir, 0700) + logsDir := agentDir.Join("logs") + if logsDir.NotExist() { + logsDir.Mkdir() } - logFile, err := os.OpenFile(filepath.Join(logsDir, logFilename), os.O_WRONLY|os.O_CREATE|os.O_SYNC|os.O_APPEND, 0644) + logFile, err := os.OpenFile(logsDir.Join(logFilename).String(), os.O_WRONLY|os.O_CREATE|os.O_SYNC|os.O_APPEND, 0644) if err != nil { log.Print("Cannot create file used for crash-report") } else { @@ -399,7 +395,7 @@ func loop() { r.POST("/update", updateHandler) // Mount goa handlers - goa := v2.Server(directory) + goa := v2.Server(agentDir.String()) r.Any("/v2/*path", gin.WrapH(goa)) go func() { diff --git a/systray/systray_real.go b/systray/systray_real.go index f06502fc6..47494aa28 100644 --- a/systray/systray_real.go +++ b/systray/systray_real.go @@ -22,11 +22,13 @@ package systray import ( "fmt" "os" + "os/user" "path/filepath" log "github.com/sirupsen/logrus" "github.com/arduino/arduino-create-agent/icon" + "github.com/arduino/go-paths-helper" "github.com/getlantern/systray" "github.com/go-ini/ini" "github.com/skratchdot/open-golang/open" @@ -101,32 +103,29 @@ func (s *Systray) updateMenuItem(item *systray.MenuItem, disable bool) { // CrashesIsEmpty checks if the folder containing crash-reports is empty func (s *Systray) CrashesIsEmpty() bool { - currDir, err := os.Getwd() - if err != nil { - log.Error("Cannot determine executable path: ", err) - } - logsDir := filepath.Join(currDir, "logs") - if _, err := os.Stat(string(logsDir)); os.IsNotExist(err) { - return true - } - return false + logsDir := getLogsDir() + return logsDir.NotExist() // if the logs directory is empty we assume there are no crashreports } // RemoveCrashes removes the crash-reports from `logs` folder func (s *Systray) RemoveCrashes() { - currDir, err := os.Getwd() - if err != nil { - log.Error("Cannot determine executable path: ", err) - } - logsDir := filepath.Join(currDir, "logs") - pathErr := os.RemoveAll(logsDir) + logsDir := getLogsDir() + pathErr := logsDir.RemoveAll() if pathErr != nil { - log.Error("Cannot remove crashreports: ", pathErr) + log.Errorf("Cannot remove crashreports: %s", pathErr) } else { - log.Info("Removed crashreports inside: ", logsDir) + log.Infof("Removed crashreports inside: %s", logsDir) } } +// getLogsDir simply returns the folder containing the logs +func getLogsDir() *paths.Path { + usr, _ := user.Current() + usrDir := paths.New(usr.HomeDir) // The user folder, on linux/macos /home// + agentDir := usrDir.Join(".arduino-create") + return agentDir.Join("logs") +} + // starthibernate creates a systray icon with menu options to resume/quit the agent func (s *Systray) startHibernate() { systray.SetIcon(icon.GetIconHiber()) @@ -189,7 +188,7 @@ type configIni struct { // getconfigs parses all config files in the executable folder func getConfigs() []configIni { // config.ini must be there, so call it Default - src, _ := os.Executable() + src, _ := os.Executable() // TODO change path dest := filepath.Dir(src) var configs []configIni From 3f9a6c68aa4c8dfdfa6f8d502895d85cb521365d Mon Sep 17 00:00:00 2001 From: Umberto Baldi Date: Mon, 5 Dec 2022 18:46:50 +0100 Subject: [PATCH 6/9] embed config file and change a bit the logic of searching --- main.go | 92 +++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 60 insertions(+), 32 deletions(-) diff --git a/main.go b/main.go index fc5199e70..298e7ebe7 100755 --- a/main.go +++ b/main.go @@ -19,6 +19,7 @@ package main import ( + _ "embed" "encoding/json" "flag" "io/ioutil" @@ -82,6 +83,9 @@ var ( crashreport = iniConf.Bool("crashreport", false, "enable crashreport logging") ) +//go:embed config.ini +var configContent []byte + // global clients var ( Tools tools.Tools @@ -181,33 +185,62 @@ func loop() { return } + log.SetLevel(log.InfoLevel) + log.SetOutput(os.Stdout) + + // the important folders of the agent src, _ := os.Executable() - srcPath := paths.New(src) - srcDir := srcPath.Parent() + srcPath := paths.New(src) // The path of the agent's binary + srcDir := srcPath.Parent() // The directory of the agent's binary + usr, _ := user.Current() + usrDir := paths.New(usr.HomeDir) // The user folder, on linux/macos /home// + agentDir := usrDir.Join(".arduino-create") + // Instantiate Tools + Tools = tools.Tools{ + Directory: agentDir.String(), + IndexURL: *indexURL, + Logger: func(msg string) { + mapD := map[string]string{"DownloadStatus": "Pending", "Msg": msg} + mapB, _ := json.Marshal(mapD) + h.broadcastSys <- mapB + }, + } + Tools.Init(requiredToolsAPILevel) + + // Let's handle the config var configPath *paths.Path - // see if the env var is defined, if it is take the config from there + // see if the env var is defined, if it is take the config from there, this will override the default path envConfig := os.Getenv("ARDUINO_CREATE_AGENT_CONFIG") if envConfig != "" { configPath = paths.New(envConfig) if configPath.NotExist() { log.Panicf("config from env var %s does not exists", envConfig) } + log.Infof("using config from env variable: %s", configPath) + // by default take the config from the ~/.arduino-create/config.ini file + } else if agentDir.Join("config.ini").Exist() { + configPath = agentDir.Join("config.ini") + log.Infof("using config from default: %s", configPath) + // take the config from the old folder where the agent's binary sits } else { - // take the config from the folder where the binary sits - configPath = srcDir.Join("config.ini") - - if configPath.NotExist() { - // probably we are on macOS, where the config is in a different dir - configPath = srcDir.Parent().Join("Resources", "config.ini") - if configPath.NotExist() { - log.Panicf("config.ini file not found in %s", configPath) + oldConfigPath := srcDir.Join("config.ini") + if oldConfigPath.Exist() { + err := oldConfigPath.CopyTo(agentDir.Join("config.ini")) + if err != nil { + log.Errorf("cannot copy old %s, to %s, generating new config", oldConfigPath, configPath) + } else { + configPath = agentDir.Join("config.ini") + log.Infof("copied old %s, to %s", oldConfigPath, configPath) } } } + if configPath == nil { + configPath = generateConfig(agentDir) + } - // Parse default ini config + // Parse the config.ini args, err := parseIni(configPath.String()) if err != nil { log.Panicf("config.ini cannot be parsed: %s", err) @@ -216,7 +249,6 @@ func loop() { if err != nil { log.Panicf("cannot parse arguments: %s", err) } - log.Infof("using config from %s", configPath) // Parse additional ini config if defined if len(*additionalConfig) > 0 { @@ -236,25 +268,6 @@ func loop() { } } - // Instantiate Tools - usr, _ := user.Current() - usrDir := paths.New(usr.HomeDir) - agentDir := usrDir.Join(".arduino-create") - Tools = tools.Tools{ - Directory: agentDir.String(), - IndexURL: *indexURL, - Logger: func(msg string) { - mapD := map[string]string{"DownloadStatus": "Pending", "Msg": msg} - mapB, _ := json.Marshal(mapD) - h.broadcastSys <- mapB - }, - } - Tools.Init(requiredToolsAPILevel) - - log.SetLevel(log.InfoLevel) - - log.SetOutput(os.Stdout) - // see if we are supposed to wait 5 seconds if *isLaunchSelf { launchSelfLater() @@ -700,3 +713,18 @@ func parseIni(filename string) (args []string, err error) { return args, nil } + +// generateConfig function will take a path as an input +// and will write the default config,ini file to that path, +// it will panic if something goes wrong +func generateConfig(destDir *paths.Path) *paths.Path { + // generate the config.ini file directly in destDir + configPath := destDir.Join("config.ini") + err := configPath.WriteFile(configContent) + if err != nil { + // if we do not have a config there's nothing else we can do + log.Panicf("cannot generate config: %s", err) + } + log.Infof("generated config in %s", configPath) + return configPath +} From fd31f876713dfe0fcdaf8ef4931f752d3e307e66 Mon Sep 17 00:00:00 2001 From: umbynos Date: Tue, 6 Dec 2022 19:14:14 +0100 Subject: [PATCH 7/9] remove `config.ini` from the CI, now it's generated by the executable --- .github/workflows/publish-go-tester-task.yml | 2 -- .github/workflows/release.yml | 6 ------ 2 files changed, 8 deletions(-) diff --git a/.github/workflows/publish-go-tester-task.yml b/.github/workflows/publish-go-tester-task.yml index 8732887e4..69efdba05 100644 --- a/.github/workflows/publish-go-tester-task.yml +++ b/.github/workflows/publish-go-tester-task.yml @@ -138,12 +138,10 @@ jobs: run: task go:build if: runner.os == 'macOS' - # config.ini is required by the executable when it's run - name: Upload artifacts uses: actions/upload-artifact@v3 with: name: arduino-create-agent-${{ matrix.os }}${{ matrix.arch }} path: | arduino-create-agent* - config.ini if-no-files-found: error diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 59d086a03..9e6837e56 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -131,14 +131,12 @@ jobs: aws s3 sync public/ s3://${{ secrets.DOWNLOADS_BUCKET }}${{ env.OLD_TARGET }} if: steps.prerelease.outputs.IS_PRE != 'true' - # config.ini is required by the executable when it's run - name: Upload artifacts uses: actions/upload-artifact@v3 with: name: ${{ env.PROJECT_NAME }}-${{ matrix.os }}${{ matrix.arch }} path: | ${{ env.PROJECT_NAME }}* - config.ini if-no-files-found: error create-macos-bundle: @@ -164,10 +162,6 @@ jobs: - name: Remove placeholder file run: rm -rf ${{ env.EXE_PATH }}.empty - - name: Move config.ini to the Resources dir - working-directory: ${{ env.EXE_PATH }} - run: mv config.ini ../Resources/ - # zip artifacts do not mantain executable permission - name: Make executable run: chmod -v +x ${{ env.EXE_PATH }}${{ env.PROJECT_NAME }} From 640587a6539d53a0ec4bcec8ab7103e4c9b3f452 Mon Sep 17 00:00:00 2001 From: Cristian Maglie Date: Thu, 9 Feb 2023 14:31:53 +0100 Subject: [PATCH 8/9] Use more appropriate directory folders for config.ini --- config.go | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ main.go | 5 +---- 2 files changed, 53 insertions(+), 4 deletions(-) create mode 100644 config.go diff --git a/config.go b/config.go new file mode 100644 index 000000000..2ce68859f --- /dev/null +++ b/config.go @@ -0,0 +1,52 @@ +// Copyright 2023 Arduino SA +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published +// by the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package main + +import ( + "fmt" + "os" + + "github.com/arduino/go-paths-helper" +) + +// getDefaultArduinoCreateConfigDir returns the full path to the default arduino create agent data directory +func getDefaultArduinoCreateConfigDir() (*paths.Path, error) { + // UserConfigDir returns the default root directory to use + // for user-specific configuration data. Users should create + // their own application-specific subdirectory within this + // one and use that. + // + // On Unix systems, it returns $XDG_CONFIG_HOME as specified by + // https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html + // if non-empty, else $HOME/.config. + // + // On Darwin, it returns $HOME/Library/Application Support. + // On Windows, it returns %AppData%. + // On Plan 9, it returns $home/lib. + // + // If the location cannot be determined (for example, $HOME + // is not defined), then it will return an error. + configDir, err := os.UserConfigDir() + if err != nil { + return nil, err + } + + agentConfigDir := paths.New(configDir, "ArduinoCreateAgent") + if err := agentConfigDir.MkdirAll(); err != nil { + return nil, fmt.Errorf("cannot create config dir: %s", err) + } + return agentConfigDir, nil +} diff --git a/main.go b/main.go index 298e7ebe7..b01b4b707 100755 --- a/main.go +++ b/main.go @@ -24,7 +24,6 @@ import ( "flag" "io/ioutil" "os" - "os/user" "runtime" "runtime/debug" "strconv" @@ -192,9 +191,7 @@ func loop() { src, _ := os.Executable() srcPath := paths.New(src) // The path of the agent's binary srcDir := srcPath.Parent() // The directory of the agent's binary - usr, _ := user.Current() - usrDir := paths.New(usr.HomeDir) // The user folder, on linux/macos /home// - agentDir := usrDir.Join(".arduino-create") + agentDir, err := getDefaultArduinoCreateConfigDir() // Instantiate Tools Tools = tools.Tools{ From 67ce93847003863a70aa1a4e6e38b20664237b63 Mon Sep 17 00:00:00 2001 From: Cristian Maglie Date: Thu, 9 Feb 2023 15:46:48 +0100 Subject: [PATCH 9/9] Moved config stuff in config.go --- config.go | 20 ++++++++++++++++++++ main.go | 32 ++++++-------------------------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/config.go b/config.go index 2ce68859f..e3225681d 100644 --- a/config.go +++ b/config.go @@ -16,10 +16,12 @@ package main import ( + _ "embed" "fmt" "os" "github.com/arduino/go-paths-helper" + log "github.com/sirupsen/logrus" ) // getDefaultArduinoCreateConfigDir returns the full path to the default arduino create agent data directory @@ -50,3 +52,21 @@ func getDefaultArduinoCreateConfigDir() (*paths.Path, error) { } return agentConfigDir, nil } + +//go:embed config.ini +var configContent []byte + +// generateConfig function will take a directory path as an input +// and will write the default config,ini file to that directory, +// it will panic if something goes wrong +func generateConfig(destDir *paths.Path) *paths.Path { + configPath := destDir.Join("config.ini") + + // generate the config.ini file directly in destDir + if err := configPath.WriteFile(configContent); err != nil { + // if we do not have a config there's nothing else we can do + panic("cannot generate config: " + err.Error()) + } + log.Infof("generated config in %s", configPath) + return configPath +} diff --git a/main.go b/main.go index b01b4b707..5cdd00ed7 100755 --- a/main.go +++ b/main.go @@ -19,7 +19,6 @@ package main import ( - _ "embed" "encoding/json" "flag" "io/ioutil" @@ -82,9 +81,6 @@ var ( crashreport = iniConf.Bool("crashreport", false, "enable crashreport logging") ) -//go:embed config.ini -var configContent []byte - // global clients var ( Tools tools.Tools @@ -209,26 +205,25 @@ func loop() { var configPath *paths.Path // see if the env var is defined, if it is take the config from there, this will override the default path - envConfig := os.Getenv("ARDUINO_CREATE_AGENT_CONFIG") - if envConfig != "" { + if envConfig := os.Getenv("ARDUINO_CREATE_AGENT_CONFIG"); envConfig != "" { configPath = paths.New(envConfig) if configPath.NotExist() { log.Panicf("config from env var %s does not exists", envConfig) } log.Infof("using config from env variable: %s", configPath) + } else if defaultConfigPath := agentDir.Join("config.ini"); defaultConfigPath.Exist() { // by default take the config from the ~/.arduino-create/config.ini file - } else if agentDir.Join("config.ini").Exist() { - configPath = agentDir.Join("config.ini") + configPath = defaultConfigPath log.Infof("using config from default: %s", configPath) - // take the config from the old folder where the agent's binary sits } else { + // take the config from the old folder where the agent's binary sits oldConfigPath := srcDir.Join("config.ini") if oldConfigPath.Exist() { - err := oldConfigPath.CopyTo(agentDir.Join("config.ini")) + err := oldConfigPath.CopyTo(defaultConfigPath) if err != nil { log.Errorf("cannot copy old %s, to %s, generating new config", oldConfigPath, configPath) } else { - configPath = agentDir.Join("config.ini") + configPath = defaultConfigPath log.Infof("copied old %s, to %s", oldConfigPath, configPath) } } @@ -710,18 +705,3 @@ func parseIni(filename string) (args []string, err error) { return args, nil } - -// generateConfig function will take a path as an input -// and will write the default config,ini file to that path, -// it will panic if something goes wrong -func generateConfig(destDir *paths.Path) *paths.Path { - // generate the config.ini file directly in destDir - configPath := destDir.Join("config.ini") - err := configPath.WriteFile(configContent) - if err != nil { - // if we do not have a config there's nothing else we can do - log.Panicf("cannot generate config: %s", err) - } - log.Infof("generated config in %s", configPath) - return configPath -}