From 8589aacb45ca95dde44ff8e18d8144550c3c68bb Mon Sep 17 00:00:00 2001 From: David Gamba Date: Tue, 18 Jul 2017 21:59:23 -0600 Subject: [PATCH] Initial commit --- LICENSE | 363 ++++++++++++++++++++++++++++++++++++++++++ Makefile | 18 +++ README.adoc | 34 ++++ semver/semver.go | 38 +++++ semver/semver_test.go | 33 ++++ xmlsect.1 | 56 +++++++ xmlsect.go | 168 +++++++++++++++++++ 7 files changed, 710 insertions(+) create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.adoc create mode 100644 semver/semver.go create mode 100644 semver/semver_test.go create mode 100644 xmlsect.1 create mode 100644 xmlsect.go diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e87a115 --- /dev/null +++ b/LICENSE @@ -0,0 +1,363 @@ +Mozilla Public License, version 2.0 + +1. Definitions + +1.1. "Contributor" + + means each individual or legal entity that creates, contributes to the + creation of, or owns Covered Software. + +1.2. "Contributor Version" + + means the combination of the Contributions of others (if any) used by a + Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + + means Source Code Form to which the initial Contributor has attached the + notice in Exhibit A, the Executable Form of such Source Code Form, and + Modifications of such Source Code Form, in each case including portions + thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + a. that the initial Contributor has attached the notice described in + Exhibit B to the Covered Software; or + + b. that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the terms of + a Secondary License. + +1.6. "Executable Form" + + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + + means a work that combines Covered Software with other material, in a + separate file or files, that is not Covered Software. + +1.8. "License" + + means this document. + +1.9. "Licensable" + + means having the right to grant, to the maximum extent possible, whether + at the time of the initial grant or subsequently, any and all of the + rights conveyed by this License. + +1.10. "Modifications" + + means any of the following: + + a. any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered Software; or + + b. any new file in Source Code Form that contains any Covered Software. + +1.11. "Patent Claims" of a Contributor + + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the License, + by the making, using, selling, offering for sale, having made, import, + or transfer of either its Contributions or its Contributor Version. + +1.12. "Secondary License" + + means either the GNU General Public License, Version 2.0, the GNU Lesser + General Public License, Version 2.1, the GNU Affero General Public + License, Version 3.0, or any later versions of those licenses. + +1.13. "Source Code Form" + + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that controls, is + controlled by, or is under common control with You. For purposes of this + definition, "control" means (a) the power, direct or indirect, to cause + the direction or management of such entity, whether by contract or + otherwise, or (b) ownership of more than fifty percent (50%) of the + outstanding shares or beneficial ownership of such entity. + + +2. License Grants and Conditions + +2.1. Grants + + Each Contributor hereby grants You a world-wide, royalty-free, + non-exclusive license: + + a. under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + + b. under Patent Claims of such Contributor to make, use, sell, offer for + sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + + The licenses granted in Section 2.1 with respect to any Contribution + become effective for each Contribution on the date the Contributor first + distributes such Contribution. + +2.3. Limitations on Grant Scope + + The licenses granted in this Section 2 are the only rights granted under + this License. No additional rights or licenses will be implied from the + distribution or licensing of Covered Software under this License. + Notwithstanding Section 2.1(b) above, no patent license is granted by a + Contributor: + + a. for any code that a Contributor has removed from Covered Software; or + + b. for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + + c. under Patent Claims infringed by Covered Software in the absence of + its Contributions. + + This License does not grant any rights in the trademarks, service marks, + or logos of any Contributor (except as may be necessary to comply with + the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + + No Contributor makes additional grants as a result of Your choice to + distribute the Covered Software under a subsequent version of this + License (see Section 10.2) or under the terms of a Secondary License (if + permitted under the terms of Section 3.3). + +2.5. Representation + + Each Contributor represents that the Contributor believes its + Contributions are its original creation(s) or it has sufficient rights to + grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + + This License is not intended to limit any rights You have under + applicable copyright doctrines of fair use, fair dealing, or other + equivalents. + +2.7. Conditions + + Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in + Section 2.1. + + +3. Responsibilities + +3.1. Distribution of Source Form + + All distribution of Covered Software in Source Code Form, including any + Modifications that You create or to which You contribute, must be under + the terms of this License. You must inform recipients that the Source + Code Form of the Covered Software is governed by the terms of this + License, and how they can obtain a copy of this License. You may not + attempt to alter or restrict the recipients' rights in the Source Code + Form. + +3.2. Distribution of Executable Form + + If You distribute Covered Software in Executable Form then: + + a. such Covered Software must also be made available in Source Code Form, + as described in Section 3.1, and You must inform recipients of the + Executable Form how they can obtain a copy of such Source Code Form by + reasonable means in a timely manner, at a charge no more than the cost + of distribution to the recipient; and + + b. You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter the + recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + + You may create and distribute a Larger Work under terms of Your choice, + provided that You also comply with the requirements of this License for + the Covered Software. If the Larger Work is a combination of Covered + Software with a work governed by one or more Secondary Licenses, and the + Covered Software is not Incompatible With Secondary Licenses, this + License permits You to additionally distribute such Covered Software + under the terms of such Secondary License(s), so that the recipient of + the Larger Work may, at their option, further distribute the Covered + Software under the terms of either this License or such Secondary + License(s). + +3.4. Notices + + You may not remove or alter the substance of any license notices + (including copyright notices, patent notices, disclaimers of warranty, or + limitations of liability) contained within the Source Code Form of the + Covered Software, except that You may alter any license notices to the + extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + + You may choose to offer, and to charge a fee for, warranty, support, + indemnity or liability obligations to one or more recipients of Covered + Software. However, You may do so only on Your own behalf, and not on + behalf of any Contributor. You must make it absolutely clear that any + such warranty, support, indemnity, or liability obligation is offered by + You alone, and You hereby agree to indemnify every Contributor for any + liability incurred by such Contributor as a result of warranty, support, + indemnity or liability terms You offer. You may include additional + disclaimers of warranty and limitations of liability specific to any + jurisdiction. + +4. Inability to Comply Due to Statute or Regulation + + If it is impossible for You to comply with any of the terms of this License + with respect to some or all of the Covered Software due to statute, + judicial order, or regulation then You must: (a) comply with the terms of + this License to the maximum extent possible; and (b) describe the + limitations and the code they affect. Such description must be placed in a + text file included with all distributions of the Covered Software under + this License. Except to the extent prohibited by statute or regulation, + such description must be sufficiently detailed for a recipient of ordinary + skill to be able to understand it. + +5. Termination + +5.1. The rights granted under this License will terminate automatically if You + fail to comply with any of its terms. However, if You become compliant, + then the rights granted under this License from a particular Contributor + are reinstated (a) provisionally, unless and until such Contributor + explicitly and finally terminates Your grants, and (b) on an ongoing + basis, if such Contributor fails to notify You of the non-compliance by + some reasonable means prior to 60 days after You have come back into + compliance. Moreover, Your grants from a particular Contributor are + reinstated on an ongoing basis if such Contributor notifies You of the + non-compliance by some reasonable means, this is the first time You have + received notice of non-compliance with this License from such + Contributor, and You become compliant prior to 30 days after Your receipt + of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent + infringement claim (excluding declaratory judgment actions, + counter-claims, and cross-claims) alleging that a Contributor Version + directly or indirectly infringes any patent, then the rights granted to + You by any and all Contributors for the Covered Software under Section + 2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user + license agreements (excluding distributors and resellers) which have been + validly granted by You or Your distributors under this License prior to + termination shall survive termination. + +6. Disclaimer of Warranty + + Covered Software is provided under this License on an "as is" basis, + without warranty of any kind, either expressed, implied, or statutory, + including, without limitation, warranties that the Covered Software is free + of defects, merchantable, fit for a particular purpose or non-infringing. + The entire risk as to the quality and performance of the Covered Software + is with You. Should any Covered Software prove defective in any respect, + You (not any Contributor) assume the cost of any necessary servicing, + repair, or correction. This disclaimer of warranty constitutes an essential + part of this License. No use of any Covered Software is authorized under + this License except under this disclaimer. + +7. Limitation of Liability + + Under no circumstances and under no legal theory, whether tort (including + negligence), contract, or otherwise, shall any Contributor, or anyone who + distributes Covered Software as permitted above, be liable to You for any + direct, indirect, special, incidental, or consequential damages of any + character including, without limitation, damages for lost profits, loss of + goodwill, work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses, even if such party shall have been + informed of the possibility of such damages. This limitation of liability + shall not apply to liability for death or personal injury resulting from + such party's negligence to the extent applicable law prohibits such + limitation. Some jurisdictions do not allow the exclusion or limitation of + incidental or consequential damages, so this exclusion and limitation may + not apply to You. + +8. Litigation + + Any litigation relating to this License may be brought only in the courts + of a jurisdiction where the defendant maintains its principal place of + business and such litigation shall be governed by laws of that + jurisdiction, without reference to its conflict-of-law provisions. Nothing + in this Section shall prevent a party's ability to bring cross-claims or + counter-claims. + +9. Miscellaneous + + This License represents the complete agreement concerning the subject + matter hereof. If any provision of this License is held to be + unenforceable, such provision shall be reformed only to the extent + necessary to make it enforceable. Any law or regulation which provides that + the language of a contract shall be construed against the drafter shall not + be used to construe this License against a Contributor. + + +10. Versions of the License + +10.1. New Versions + + Mozilla Foundation is the license steward. Except as provided in Section + 10.3, no one other than the license steward has the right to modify or + publish new versions of this License. Each version will be given a + distinguishing version number. + +10.2. Effect of New Versions + + You may distribute the Covered Software under the terms of the version + of the License under which You originally received the Covered Software, + or under the terms of any subsequent version published by the license + steward. + +10.3. Modified Versions + + If you create software not governed by this License, and you want to + create a new license for such software, you may create and use a + modified version of this License if you rename the license and remove + any references to the name of the license steward (except to note that + such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary + Licenses If You choose to distribute Source Code Form that is + Incompatible With Secondary Licenses under the terms of this version of + the License, the notice described in Exhibit B of this License must be + attached. + +Exhibit A - Source Code Form License Notice + + This Source Code Form is subject to the + terms of the Mozilla Public License, v. + 2.0. If a copy of the MPL was not + distributed with this file, You can + obtain one at + http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular file, +then You may include the notice in a location (such as a LICENSE file in a +relevant directory) where a recipient would be likely to look for such a +notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice + + This Source Code Form is "Incompatible + With Secondary Licenses", as defined by + the Mozilla Public License, v. 2.0. + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..1d14657 --- /dev/null +++ b/Makefile @@ -0,0 +1,18 @@ +# This file is part of xmlsect. +# +# Copyright (C) 2017 David Gamba Rios +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +BUILD_FLAGS=-ldflags="-X github.com/davidgamba/xmlsect/semver.BuildMetadata=`git rev-parse HEAD`" + +test: + go test ./... + +build: + go build $(BUILD_FLAGS) + +install: + go install $(BUILD_FLAGS) xmlsect.go diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..b76df02 --- /dev/null +++ b/README.adoc @@ -0,0 +1,34 @@ += XML Sectrix (xmlsect) (1) +David Gamba, davidgamba at gmail.com +:doctype: manpage + +== NAME + +xmlsect - Quickly query an XML file using XPath 1.0. + +This tool reads a whole XML file into memory, extracts its XML Namespaces using a regular expression and then loads all the _namespaces_ for you. + +When there is a default namespace, it automatically loads it under the namespace ID *ns*. +An example XPath would then look like `/ns:a/ns:b/ns:c`. + +== SYNOPSIS + +*xmlsect* _file_ [_xpath_] + +== Credits + +This tool is using the awesome libraries created by Santhosh Kumar Tekuri, https://github.com/santhosh-tekuri/xpath[xpath] and https://github.com/santhosh-tekuri/dom[dom]. + +== SOURCE CODE + +github: https://github.com/DavidGamba/xmlsect + +== LICENSE + +This file is part of xmlsect. + +Copyright (C) 2017 David Gamba Rios + +This Source Code Form is subject to the terms of the Mozilla Public +License, v. 2.0. If a copy of the MPL was not distributed with this +file, You can obtain one at http://mozilla.org/MPL/2.0/. diff --git a/semver/semver.go b/semver/semver.go new file mode 100644 index 0000000..e945c48 --- /dev/null +++ b/semver/semver.go @@ -0,0 +1,38 @@ +// This file is part of xmlsect. +// +// Copyright (C) 2017 David Gamba Rios +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +/* +Package semver - Allows you to provide a simple consistent way to version +different projects using SemVer. + +It doesn't verify the PreReleaseLabel or the BuildMetadata for correctness. +*/ +package semver + +import "fmt" + +// The Version struct contains the information that MUST be provided in order to properly version a program. +type Version struct { + Major, Minor, Patch int + PreReleaseLabel string +} + +// BuildMetadata is an optional field of the SemVer version. +var BuildMetadata string + +func (sv Version) String() string { + var label string + var build string + if sv.PreReleaseLabel != "" { + label = fmt.Sprintf("-%s", sv.PreReleaseLabel) + } + if BuildMetadata != "" { + build = fmt.Sprintf("+%s", BuildMetadata) + } + return fmt.Sprintf("%d.%d.%d%s%s", sv.Major, sv.Minor, sv.Patch, label, build) +} diff --git a/semver/semver_test.go b/semver/semver_test.go new file mode 100644 index 0000000..544f56b --- /dev/null +++ b/semver/semver_test.go @@ -0,0 +1,33 @@ +// This file is part of xmlsect. +// +// Copyright (C) 2017 David Gamba Rios +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +package semver + +import "testing" + +func TestVersion(t *testing.T) { + v := Version{1, 2, 3, ""} + if v.String() != "1.2.3" { + t.Fatalf("Version: 1.2.3 != %s\n", v.String()) + } +} + +func TestPreReleaseLabel(t *testing.T) { + v := Version{1, 2, 3, "alpha"} + if v.String() != "1.2.3-alpha" { + t.Fatalf("Version: 1.2.3-alpha != %s\n", v.String()) + } +} + +func TestBuildMetadata(t *testing.T) { + BuildMetadata = "abc" + v := Version{1, 2, 3, "alpha"} + if v.String() != "1.2.3-alpha+abc" { + t.Fatalf("Version: 1.2.3-alpha+abc != %s\n", v.String()) + } +} diff --git a/xmlsect.1 b/xmlsect.1 new file mode 100644 index 0000000..2f77276 --- /dev/null +++ b/xmlsect.1 @@ -0,0 +1,56 @@ +'\" t +.\" Title: xml sectrix (xmlsect) +.\" Author: David Gamba, davidgamba at gmail.com +.\" Generator: Asciidoctor 1.5.5 +.\" Date: 2017-07-19 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "XMLSECT" "1" "2017-07-19" "\ \&" "\ \&" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.LINKSTYLE blue R < > +.SH "NAME" +xml sectrix (xmlsect) \- Quickly query an XML file using XPath 1.0. +.sp +This tool reads a whole XML file into memory, extracts its XML Namespaces using a regular expression and then loads all the \fInamespaces\fP for you. +.sp +When there is a default namespace, it automatically loads it under the namespace ID \fBns\fP. +An example XPath would then look like \f[CR]/ns:a/ns:b/ns:c\fP. +.SH "SYNOPSIS" +.sp +\fBxmlsect\fP \fIfile\fP [\fIxpath\fP] +.SH "CREDITS" +.sp +This tool is using the awesome libraries created by Santhosh Kumar Tekuri, \c +.URL "https://github.com/santhosh\-tekuri/xpath" "xpath" " " +and +.URL "https://github.com/santhosh\-tekuri/dom" "dom" "." +.SH "SOURCE CODE" +.sp +github: \c +.URL "https://github.com/DavidGamba/xmlsect" "" "" +.SH "LICENSE" +.sp +This file is part of xmlsect. +.sp +Copyright \(co 2017 David Gamba Rios +.sp +This Source Code Form is subject to the terms of the Mozilla Public +License, v. 2.0. If a copy of the MPL was not distributed with this +file, You can obtain one at \c +.URL "http://mozilla.org/MPL/2.0/" "" "." +.SH "AUTHOR(S)" +.sp +\fBDavid Gamba, davidgamba at gmail.com\fP +.RS 4 +Author(s). +.RE \ No newline at end of file diff --git a/xmlsect.go b/xmlsect.go new file mode 100644 index 0000000..f3991ca --- /dev/null +++ b/xmlsect.go @@ -0,0 +1,168 @@ +// This file is part of xmlsect. +// +// Copyright (C) 2017 David Gamba Rios +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +package main + +import ( + "bytes" + "encoding/xml" + "fmt" + "io/ioutil" + "log" + "os" + "regexp" + + "github.com/davidgamba/go-getoptions" + "github.com/davidgamba/xmlsect/semver" + "github.com/santhosh-tekuri/dom" + "github.com/santhosh-tekuri/xpath" +) + +func extractXMLNS(b []byte) map[string]string { + xmlnsMap := make(map[string]string) + r := regexp.MustCompile(`xmlns:?([^=]*)=["']?([^"'\s]+)["']?`) + rm := r.FindAllSubmatch(b, -1) + for _, m := range rm { + // 0 - whole match, 1 - nsid, 2 - ns + nsid := string(m[1]) + ns := string(m[2]) + if nsid == "" { + nsid = "ns" + fmt.Fprintf(os.Stderr, "Found default namespace: %s\nUse 'ns' as the namespace ID for xpath: /ns:a/ns:b/ns:c\n\n", ns) + } else { + fmt.Fprintf(os.Stderr, "Found '%s' namespace: %s\n\n", nsid, ns) + } + // TODO: Check for duplicate nsid + xmlnsMap[nsid] = ns + } + return xmlnsMap +} + +func printNodeSet(n []dom.Node) { + var handled bool + for _, e := range n { + switch t := e.(type) { + case *dom.Attr: + fmt.Printf("%s=%s\n", t.Name, t.Value) + handled = true + case *dom.Text: + fmt.Printf("%s\n", t.Data) + handled = true + } + } + if !handled { + doc := &dom.Document{n} + printDoc(doc) + } +} + +func printDoc(doc *dom.Document) { + buf := new(bytes.Buffer) + if err := dom.Marshal(doc, buf); err != nil { + fmt.Fprintf(os.Stderr, "ERROR: %s\n", err) + return + } + fmt.Printf("%s\n", buf.String()) +} + +func synopsis() { + synopsis := `# USAGE: + xsect [] [] + + xsect [--help] +` + fmt.Fprintln(os.Stderr, synopsis) +} + +func main() { + opt := getoptions.New() + opt.Bool("help", false) + opt.Bool("debug", false) + opt.Bool("version", false) + remaining, err := opt.Parse(os.Args[1:]) + if err != nil { + fmt.Fprintf(os.Stderr, "ERROR: %s\n", err) + os.Exit(1) + } + if opt.Called("help") { + synopsis() + os.Exit(1) + } + if opt.Called("version") { + version := semver.Version{Major: 0, Minor: 1, Patch: 0} + fmt.Println(version) + os.Exit(1) + } + if !opt.Called("debug") { + log.SetOutput(ioutil.Discard) + } + log.Println(remaining) + var file, xpathQuery, xpathRelQuery string + // var file, xpathQuery string + l := len(remaining) + switch { + case l < 1: + fmt.Fprintf(os.Stderr, "ERROR: Missing file!\n") + synopsis() + os.Exit(1) + case l == 1: + file = remaining[0] + xpathQuery = "/" + case l == 2: + file = remaining[0] + xpathQuery = remaining[1] + case l >= 3: + file = remaining[0] + xpathQuery = remaining[1] + xpathRelQuery = remaining[2] + } + + b, err := ioutil.ReadFile(file) + if err != nil { + fmt.Fprintf(os.Stderr, "ERROR: %s\n", err) + os.Exit(1) + } + xmlnsMap := extractXMLNS(b) + doc, err := dom.Unmarshal(xml.NewDecoder(bytes.NewReader(b))) + if err != nil { + fmt.Fprintf(os.Stderr, "ERROR: %s\n", err) + os.Exit(1) + } + compiler := &xpath.Compiler{ + Namespaces: xmlnsMap, + } + expr, err := compiler.Compile(xpathQuery) + if err != nil { + fmt.Fprintf(os.Stderr, "ERROR: %s\n", err) + os.Exit(1) + } + log.Printf("xpath %s\n", expr) + nodeSet, err := expr.EvalNodeSet(doc, nil) + if err != nil { + fmt.Fprintf(os.Stderr, "ERROR: %s\n", err) + os.Exit(1) + } + log.Printf("results: %d\n", len(nodeSet)) + printNodeSet(nodeSet) + if xpathRelQuery != "" { + doc := &dom.Document{nodeSet} + expr, err := compiler.Compile(xpathRelQuery) + if err != nil { + fmt.Fprintf(os.Stderr, "ERROR: %s\n", err) + os.Exit(1) + } + log.Printf("xpath %s\n", expr) + nodeSet, err := expr.EvalNodeSet(doc, nil) + if err != nil { + fmt.Fprintf(os.Stderr, "ERROR: %s\n", err) + os.Exit(1) + } + log.Printf("results: %d\n", len(nodeSet)) + printNodeSet(nodeSet) + } +}