commit 352810c3097df0b24b65ed809666b104b10960db Author: Tigor Hutasuhut Date: Tue Jun 25 00:19:15 2024 +0700 initial commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7e60fab --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Tigor Hutasuhut + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/cmd/qbitrun/cli/cli.go b/cmd/qbitrun/cli/cli.go new file mode 100644 index 0000000..592498e --- /dev/null +++ b/cmd/qbitrun/cli/cli.go @@ -0,0 +1,68 @@ +package cli + +import ( + "fmt" + "os" + "path" + + "github.com/spf13/cobra" +) + +var ( + // LookUpMode is the default behavior to look up workflow files. + // + // Valid values are: + // - "xdg": look up in XDG_CONFIG_HOME/qbitrun/workflows + // - "cwd": look up workflows dir in the current working directory + // - other: look up workflows dir in the same directory as the executable + LookUpMode string + Version string +) + +var RootCmd = &cobra.Command{ + Use: "qbitrun", + Short: "qbitrun is a CLI tool to handle qBittorrent pre/post processing tasks", + Long: "qbitrun is a CLI tool to handle qBittorrent pre/post processing tasks. It uses matchers defined in yaml files to determine which tasks to run on which torrents post download.", + PersistentPreRun: func(cmd *cobra.Command, args []string) { + if cmd.PersistentFlags().Changed("version") { + fmt.Println(Version) + os.Exit(0) + } + }, + Run: func(cmd *cobra.Command, args []string) { + cmd.HelpFunc()(cmd, args) + }, +} + +func init() { + persistFlag := RootCmd.PersistentFlags() + + var workflowDir string + switch LookUpMode { + case "xdg": + xdgConfigHome := os.Getenv("XDG_CONFIG_HOME") + if xdgConfigHome == "" { + xdgConfigHome = path.Join(os.Getenv("HOME"), ".config") + } + workflowDir = path.Join(xdgConfigHome, "qbitrun", "workflows") + case "cwd": + cwd, err := os.Getwd() + if err != nil { + panic(fmt.Errorf("failed to get current working directory: %w", err)) + } + workflowDir = path.Join(cwd, "workflows") + default: + exe, err := os.Executable() + if err != nil { + panic(fmt.Errorf("failed to get executable path: %w", err)) + } + workflowDir = path.Join(path.Dir(exe), "workflows") + } + + persistFlag.StringP( + "workflow-dir", + "d", + workflowDir, + "Set the directory where the workflow yaml files are stored.") + persistFlag.BoolP("version", "v", false, "Print the version of qbitrun and exit") +} diff --git a/cmd/qbitrun/cli/handle.go b/cmd/qbitrun/cli/handle.go new file mode 100644 index 0000000..5ad9b53 --- /dev/null +++ b/cmd/qbitrun/cli/handle.go @@ -0,0 +1,72 @@ +package cli + +import "github.com/spf13/cobra" + +type handleArgsS struct { + torrentName string + category string + tags []string + contentPath string + rootPath string + savePath string + numberOfFiles int + torrentSize uint64 + currentTracker string + infoHashV1 string + infoHashV2 string + torrentID string + addEvent bool +} + +var handleArgs = handleArgsS{} + +var handleCmd = &cobra.Command{ + Use: "handle", + Short: "Handles a torrent event from QBittorrent", + Run: func(cmd *cobra.Command, args []string) { + }, +} + +func init() { + flags := handleCmd.Flags() + + flags.BoolVarP(&handleArgs.addEvent, "add-event", "a", false, "mark this event as add torrent event") + + flags.StringVarP(&handleArgs.torrentName, "torrent-name", "N", "", "Torrent Name") + handleCmd.MarkFlagRequired("torrent-name") + + flags.StringVarP(&handleArgs.category, "category", "L", "", "Category") + handleCmd.MarkFlagRequired("category") + + flags.StringSliceVarP(&handleArgs.tags, "tags", "G", []string{}, "Tags (seperated by comma)") + handleCmd.MarkFlagRequired("tags") + + flags.StringVarP(&handleArgs.contentPath, "content-path", "F", "", "Content Path (same as root path for multifile torrent") + handleCmd.MarkFlagRequired("content-path") + + flags.StringVarP(&handleArgs.rootPath, "root-path", "R", "", "Root path (first torrent subdirectory path)") + handleCmd.MarkFlagRequired("root-path") + + flags.StringVarP(&handleArgs.savePath, "save-path", "D", "", "Save path") + handleCmd.MarkFlagRequired("save-path") + + flags.IntVarP(&handleArgs.numberOfFiles, "number-of-files", "C", 0, "Number of files") + handleCmd.MarkFlagRequired("number-of-files") + + flags.Uint64VarP(&handleArgs.torrentSize, "torrent-size", "Z", 0, "Torrent size") + handleCmd.MarkFlagRequired("torrent-size") + + flags.StringVarP(&handleArgs.currentTracker, "current-tracker", "T", "", "Current tracker") + handleCmd.MarkFlagRequired("current-tracker") + + flags.StringVarP(&handleArgs.infoHashV1, "info-hash-v1", "I", "", "Info hash v1") + handleCmd.MarkFlagRequired("info-hash-v1") + + flags.StringVarP(&handleArgs.infoHashV2, "info-hash-v2", "J", "", "Info hash v2") + handleCmd.MarkFlagRequired("info-hash-v2") + + flags.StringVarP(&handleArgs.torrentID, "torrent-id", "K", "", "Torrent ID") + handleCmd.MarkFlagRequired("torrent-id") + + RootCmd.AddCommand(handleCmd) +} diff --git a/cmd/qbitrun/main.go b/cmd/qbitrun/main.go new file mode 100644 index 0000000..d7ec710 --- /dev/null +++ b/cmd/qbitrun/main.go @@ -0,0 +1,52 @@ +package main + +import ( + "context" + "os" + "os/signal" + + "github.com/tigorlazuardi/qbitrun/cmd/qbitrun/cli" +) + +var ( + Build string = "v0.0.0" + + // LookUpMode should be handled by LDFlags (subject to change) or perhaps ENV (or both). + // + // This behavior will determine where to look up workflow files. + // + // XDG mode will be bad for standalone binary, as users is expected to put + // their workflow dir next to the executable itself. + // + // Packaged mode where the exe is in normally unreachable location for runtime files (e.g. /usr/bin) + // will expect users to put their workflow files in XDG dirs. + // + // Others probably wants where the CWD contains the workflow dir. + // + // All of this is supllanted by the --workflow-dir flag though. + // So Users should be told to use that for consistent behavior + // or when using multiple qBittorrent instances and want + // to use different workflow dirs. + // + // Expected values: + // - "xdg": look up in XDG_CONFIG_HOME/qbitrun/workflows + // - "cwd": look up workflows dir in the current working directory + // - other: look up workflows dir in the same directory as the executable + // + // NOTE: + // Unlike config files, layered heuristics is probably not a good idea since User + // does not expect workflow files to be looked up in different places and merged. + LookUpMode string = "exe" +) + +func main() { + cli.Version = Build + cli.LookUpMode = LookUpMode + + ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt) + defer cancel() + + if err := cli.RootCmd.ExecuteContext(ctx); err != nil { + os.Exit(1) + } +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..c4925ce --- /dev/null +++ b/go.mod @@ -0,0 +1,9 @@ +module github.com/tigorlazuardi/qbitrun + +go 1.22.3 + +require ( + github.com/inconshreveable/mousetrap v1.1.0 // indirect + github.com/spf13/cobra v1.8.1 // indirect + github.com/spf13/pflag v1.0.5 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..912390a --- /dev/null +++ b/go.sum @@ -0,0 +1,10 @@ +github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= +github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM= +github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y= +github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=