From eb26857c1d5973bedc91c3fc1acaf4434809bbd5 Mon Sep 17 00:00:00 2001 From: Christine Dodrill Date: Mon, 9 Dec 2019 10:48:40 -0500 Subject: Within package layout (#102) * blog: go package layout * eat my own dogfood * internal: test date * blog/go-package-layout: streamline * oops --- cmd/site/html.go | 4 +- cmd/site/internal/blog/blog.go | 136 ++++++++++ cmd/site/internal/blog/blog_test.go | 66 +++++ cmd/site/internal/date.go | 10 + cmd/site/internal/date_test.go | 28 ++ cmd/site/internal/front/LICENSE | 19 ++ cmd/site/internal/front/front.go | 24 ++ cmd/site/internal/front/front_test.go | 42 +++ cmd/site/internal/hash.go | 14 + cmd/site/internal/jsonfeed/.travis.yml | 17 ++ cmd/site/internal/jsonfeed/LICENSE | 363 ++++++++++++++++++++++++++ cmd/site/internal/jsonfeed/README.md | 8 + cmd/site/internal/jsonfeed/jsonfeed.go | 73 ++++++ cmd/site/internal/jsonfeed/jsonfeed_test.go | 43 +++ cmd/site/internal/jsonfeed/testdata/feed.json | 21 ++ cmd/site/internal/middleware/metrics.go | 43 +++ cmd/site/internal/middleware/requestid.go | 31 +++ cmd/site/main.go | 6 +- cmd/site/rss.go | 2 +- internal/blog/blog.go | 136 ---------- internal/blog/blog_test.go | 66 ----- internal/date.go | 10 - internal/front/LICENSE | 19 -- internal/front/front.go | 24 -- internal/front/front_test.go | 42 --- internal/hash.go | 14 - internal/jsonfeed/.travis.yml | 17 -- internal/jsonfeed/LICENSE | 363 -------------------------- internal/jsonfeed/README.md | 8 - internal/jsonfeed/jsonfeed.go | 73 ------ internal/jsonfeed/jsonfeed_test.go | 43 --- internal/jsonfeed/testdata/feed.json | 21 -- internal/middleware/metrics.go | 43 --- internal/middleware/requestid.go | 31 --- 34 files changed, 944 insertions(+), 916 deletions(-) create mode 100644 cmd/site/internal/blog/blog.go create mode 100644 cmd/site/internal/blog/blog_test.go create mode 100644 cmd/site/internal/date.go create mode 100644 cmd/site/internal/date_test.go create mode 100644 cmd/site/internal/front/LICENSE create mode 100644 cmd/site/internal/front/front.go create mode 100644 cmd/site/internal/front/front_test.go create mode 100644 cmd/site/internal/hash.go create mode 100644 cmd/site/internal/jsonfeed/.travis.yml create mode 100644 cmd/site/internal/jsonfeed/LICENSE create mode 100644 cmd/site/internal/jsonfeed/README.md create mode 100644 cmd/site/internal/jsonfeed/jsonfeed.go create mode 100644 cmd/site/internal/jsonfeed/jsonfeed_test.go create mode 100644 cmd/site/internal/jsonfeed/testdata/feed.json create mode 100644 cmd/site/internal/middleware/metrics.go create mode 100644 cmd/site/internal/middleware/requestid.go delete mode 100644 internal/blog/blog.go delete mode 100644 internal/blog/blog_test.go delete mode 100644 internal/date.go delete mode 100644 internal/front/LICENSE delete mode 100644 internal/front/front.go delete mode 100644 internal/front/front_test.go delete mode 100644 internal/hash.go delete mode 100644 internal/jsonfeed/.travis.yml delete mode 100644 internal/jsonfeed/LICENSE delete mode 100644 internal/jsonfeed/README.md delete mode 100644 internal/jsonfeed/jsonfeed.go delete mode 100644 internal/jsonfeed/jsonfeed_test.go delete mode 100644 internal/jsonfeed/testdata/feed.json delete mode 100644 internal/middleware/metrics.go delete mode 100644 internal/middleware/requestid.go diff --git a/cmd/site/html.go b/cmd/site/html.go index 912ad77..37acba8 100644 --- a/cmd/site/html.go +++ b/cmd/site/html.go @@ -9,8 +9,8 @@ import ( "strings" "time" - "christine.website/internal" - "christine.website/internal/blog" + "christine.website/cmd/site/internal" + "christine.website/cmd/site/internal/blog" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promauto" "within.website/ln" diff --git a/cmd/site/internal/blog/blog.go b/cmd/site/internal/blog/blog.go new file mode 100644 index 0000000..0ea6fb2 --- /dev/null +++ b/cmd/site/internal/blog/blog.go @@ -0,0 +1,136 @@ +package blog + +import ( + "html/template" + "io/ioutil" + "os" + "path/filepath" + "sort" + "strings" + "time" + + "christine.website/cmd/site/internal/front" + "github.com/russross/blackfriday" +) + +// Post is a single blogpost. +type Post struct { + Title string `json:"title"` + Link string `json:"link"` + Summary string `json:"summary,omitifempty"` + Body string `json:"-"` + BodyHTML template.HTML `json:"body"` + Series string `json:"series"` + Tags []string `json:"tags"` + SlidesLink string `json:"slides_link"` + ImageURL string `json:"image_url"` + ThumbURL string `json:"thumb_url"` + Date time.Time + DateString string `json:"date"` +} + +// Posts implements sort.Interface for a slice of Post objects. +type Posts []Post + +func (p Posts) Series() []string { + names := map[string]struct{}{} + + for _, ps := range p { + if ps.Series != "" { + names[ps.Series] = struct{}{} + } + } + + var result []string + + for name := range names { + result = append(result, name) + } + + return result +} + +func (p Posts) Len() int { return len(p) } +func (p Posts) Less(i, j int) bool { + iDate := p[i].Date + jDate := p[j].Date + + return iDate.Unix() < jDate.Unix() +} +func (p Posts) Swap(i, j int) { p[i], p[j] = p[j], p[i] } + +// LoadPosts loads posts for a given directory. +func LoadPosts(path string, prepend string) (Posts, error) { + type postFM struct { + Title string + Date string + Series string + Tags []string + SlidesLink string `yaml:"slides_link"` + Image string + Thumb string + } + var result Posts + + err := filepath.Walk(path, func(path string, info os.FileInfo, err error) error { + if err != nil { + return err + } + + if info.IsDir() { + return nil + } + + fin, err := os.Open(path) + if err != nil { + return err + } + defer fin.Close() + + content, err := ioutil.ReadAll(fin) + if err != nil { + return err + } + + var fm postFM + remaining, err := front.Unmarshal(content, &fm) + if err != nil { + return err + } + + output := blackfriday.Run(remaining) + + const timeFormat = `2006-01-02` + date, err := time.Parse(timeFormat, fm.Date) + if err != nil { + return err + } + + fname := filepath.Base(path) + fname = strings.TrimSuffix(fname, filepath.Ext(fname)) + + p := Post{ + Title: fm.Title, + Date: date, + DateString: fm.Date, + Link: filepath.Join(prepend, fname), + Body: string(remaining), + BodyHTML: template.HTML(output), + SlidesLink: fm.SlidesLink, + Series: fm.Series, + Tags: fm.Tags, + ImageURL: fm.Image, + ThumbURL: fm.Thumb, + } + result = append(result, p) + + return nil + }) + if err != nil { + return nil, err + } + + sort.Sort(sort.Reverse(result)) + + return result, nil +} diff --git a/cmd/site/internal/blog/blog_test.go b/cmd/site/internal/blog/blog_test.go new file mode 100644 index 0000000..6f44a30 --- /dev/null +++ b/cmd/site/internal/blog/blog_test.go @@ -0,0 +1,66 @@ +package blog + +import ( + "testing" +) + +func TestLoadPosts(t *testing.T) { + posts, err := LoadPosts("../../../../blog", "blog") + if err != nil { + t.Fatal(err) + } + + for _, post := range posts { + t.Run(post.Link, post.test) + } +} + +func TestLoadTalks(t *testing.T) { + talks, err := LoadPosts("../../../../talks", "talks") + if err != nil { + t.Fatal(err) + } + + for _, talk := range talks { + t.Run(talk.Link, talk.test) + if talk.SlidesLink == "" { + t.Errorf("talk %s (%s) doesn't have a slides link", talk.Title, talk.DateString) + } + } +} + +func TestLoadGallery(t *testing.T) { + gallery, err := LoadPosts("../../../../gallery", "gallery") + if err != nil { + t.Fatal(err) + } + + for _, art := range gallery { + t.Run(art.Link, art.test) + if art.ImageURL == "" { + t.Errorf("art %s (%s) doesn't have an image link", art.Title, art.DateString) + } + if art.ThumbURL == "" { + t.Errorf("art %s (%s) doesn't have a thumbnail link", art.Title, art.DateString) + } + + } +} + +func (p Post) test(t *testing.T) { + if p.Title == "" { + t.Error("no post title") + } + + if p.DateString == "" { + t.Error("no date") + } + + if p.Link == "" { + t.Error("no link") + } + + if p.Body == "" { + t.Error("no body") + } +} diff --git a/cmd/site/internal/date.go b/cmd/site/internal/date.go new file mode 100644 index 0000000..960cdc2 --- /dev/null +++ b/cmd/site/internal/date.go @@ -0,0 +1,10 @@ +package internal + +import "time" + +const iOS13DetriFormat = `2006 M1 2` + +// IOS13Detri formats a datestamp like iOS 13 does with the Lojban locale. +func IOS13Detri(t time.Time) string { + return t.Format(iOS13DetriFormat) +} diff --git a/cmd/site/internal/date_test.go b/cmd/site/internal/date_test.go new file mode 100644 index 0000000..60254f9 --- /dev/null +++ b/cmd/site/internal/date_test.go @@ -0,0 +1,28 @@ +package internal + +import ( + "fmt" + "testing" + "time" +) + +func TestIOS13Detri(t *testing.T) { + cases := []struct { + in time.Time + out string + }{ + { + in: time.Date(2019, time.March, 30, 0, 0, 0, 0, time.FixedZone("UTC", 0)), + out: "2019 M3 30", + }, + } + + for _, cs := range cases { + t.Run(fmt.Sprintf("%s -> %s", cs.in.Format(time.RFC3339), cs.out), func(t *testing.T) { + result := IOS13Detri(cs.in) + if result != cs.out { + t.Fatalf("wanted: %s, got: %s", cs.out, result) + } + }) + } +} diff --git a/cmd/site/internal/front/LICENSE b/cmd/site/internal/front/LICENSE new file mode 100644 index 0000000..e8152bb --- /dev/null +++ b/cmd/site/internal/front/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2017 TJ Holowaychuk + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/cmd/site/internal/front/front.go b/cmd/site/internal/front/front.go new file mode 100644 index 0000000..b2c7f0e --- /dev/null +++ b/cmd/site/internal/front/front.go @@ -0,0 +1,24 @@ +// Package front provides YAML frontmatter unmarshalling. +package front + +import ( + "bytes" + + "gopkg.in/yaml.v2" +) + +// Delimiter. +var delim = []byte("---") + +// Unmarshal parses YAML frontmatter and returns the content. When no +// frontmatter delimiters are present the original content is returned. +func Unmarshal(b []byte, v interface{}) (content []byte, err error) { + if !bytes.HasPrefix(b, delim) { + return b, nil + } + + parts := bytes.SplitN(b, delim, 3) + content = parts[2] + err = yaml.Unmarshal(parts[1], v) + return +} diff --git a/cmd/site/internal/front/front_test.go b/cmd/site/internal/front/front_test.go new file mode 100644 index 0000000..bdc56d1 --- /dev/null +++ b/cmd/site/internal/front/front_test.go @@ -0,0 +1,42 @@ +package front_test + +import ( + "fmt" + "log" + + "christine.website/cmd/site/internal/front" +) + +var markdown = []byte(`--- +title: Ferrets +authors: + - Tobi + - Loki + - Jane +--- +Some content here, so +interesting, you just +want to keep reading.`) + +type article struct { + Title string + Authors []string +} + +func Example() { + var a article + + content, err := front.Unmarshal(markdown, &a) + if err != nil { + log.Fatalf("error unmarshalling: %s", err) + } + + fmt.Printf("%#v\n", a) + fmt.Printf("%s\n", string(content)) + // Output: + // front_test.article{Title:"Ferrets", Authors:[]string{"Tobi", "Loki", "Jane"}} + // + // Some content here, so + // interesting, you just + // want to keep reading. +} diff --git a/cmd/site/internal/hash.go b/cmd/site/internal/hash.go new file mode 100644 index 0000000..ee333da --- /dev/null +++ b/cmd/site/internal/hash.go @@ -0,0 +1,14 @@ +package internal + +import ( + "crypto/md5" + "fmt" +) + +// Hash is a simple wrapper around the MD5 algorithm implementation in the +// Go standard library. It takes in data and a salt and returns the hashed +// representation. +func Hash(data string, salt string) string { + output := md5.Sum([]byte(data + salt)) + return fmt.Sprintf("%x", output) +} diff --git a/cmd/site/internal/jsonfeed/.travis.yml b/cmd/site/internal/jsonfeed/.travis.yml new file mode 100644 index 0000000..e872c60 --- /dev/null +++ b/cmd/site/internal/jsonfeed/.travis.yml @@ -0,0 +1,17 @@ +# 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/ + +language: go + +go: + - 1.8.1 + +before_install: + - go get -t -v ./... + +script: + - go test -race -coverprofile=coverage.txt -covermode=atomic + +after_success: + - bash <(curl -s https://codecov.io/bash) diff --git a/cmd/site/internal/jsonfeed/LICENSE b/cmd/site/internal/jsonfeed/LICENSE new file mode 100644 index 0000000..e87a115 --- /dev/null +++ b/cmd/site/internal/jsonfeed/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/cmd/site/internal/jsonfeed/README.md b/cmd/site/internal/jsonfeed/README.md new file mode 100644 index 0000000..27f7cb5 --- /dev/null +++ b/cmd/site/internal/jsonfeed/README.md @@ -0,0 +1,8 @@ +# JSONFeed - Go Package to parse JSON Feed streams + +[![Build Status](https://travis-ci.org/st3fan/jsonfeed.svg?branch=master)](https://travis-ci.org/st3fan/jsonfeed) [![Go Report Card](https://goreportcard.com/badge/github.com/st3fan/jsonfeed)](https://goreportcard.com/report/github.com/st3fan/jsonfeed) [![codecov](https://codecov.io/gh/st3fan/jsonfeed/branch/master/graph/badge.svg)](https://codecov.io/gh/st3fan/jsonfeed) + + +*Stefan Arentz, May 2017* + +Work in progress. Minimal package to parse JSON Feed streams. Please file feature requests. diff --git a/cmd/site/internal/jsonfeed/jsonfeed.go b/cmd/site/internal/jsonfeed/jsonfeed.go new file mode 100644 index 0000000..913880d --- /dev/null +++ b/cmd/site/internal/jsonfeed/jsonfeed.go @@ -0,0 +1,73 @@ +// 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 jsonfeed + +import ( + "encoding/json" + "io" + "time" +) + +const CurrentVersion = "https://jsonfeed.org/version/1" + +type Item struct { + ID string `json:"id"` + URL string `json:"url"` + ExternalURL string `json:"external_url"` + Title string `json:"title"` + ContentHTML string `json:"content_html"` + ContentText string `json:"content_text"` + Summary string `json:"summary"` + Image string `json:"image"` + BannerImage string `json:"banner_image"` + DatePublished time.Time `json:"date_published"` + DateModified time.Time `json:"date_modified"` + Author Author `json:"author"` + Tags []string `json:"tags"` +} + +type Author struct { + Name string `json:"name"` + URL string `json:"url"` + Avatar string `json:"avatar"` +} + +type Hub struct { + Type string `json:"type"` + URL string `json:"url"` +} + +type Attachment struct { + URL string `json:"url"` + MIMEType string `json:"mime_type"` + Title string `json:"title"` + SizeInBytes int64 `json:"size_in_bytes"` + DurationInSeconds int64 `json:"duration_in_seconds"` +} + +type Feed struct { + Version string `json:"version"` + Title string `json:"title"` + HomePageURL string `json:"home_page_url"` + FeedURL string `json:"feed_url"` + Description string `json:"description"` + UserComment string `json:"user_comment"` + NextURL string `json:"next_url"` + Icon string `json:"icon"` + Favicon string `json:"favicon"` + Author Author `json:"author"` + Expired bool `json:"expired"` + Hubs []Hub `json:"hubs"` + Items []Item `json:"items"` +} + +func Parse(r io.Reader) (Feed, error) { + var feed Feed + decoder := json.NewDecoder(r) + if err := decoder.Decode(&feed); err != nil { + return Feed{}, err + } + return feed, nil +} diff --git a/cmd/site/internal/jsonfeed/jsonfeed_test.go b/cmd/site/internal/jsonfeed/jsonfeed_test.go new file mode 100644 index 0000000..cd071d7 --- /dev/null +++ b/cmd/site/internal/jsonfeed/jsonfeed_test.go @@ -0,0 +1,43 @@ +// 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 jsonfeed_test + +import ( + "os" + "testing" + "time" + + "christine.website/cmd/site/internal/jsonfeed" + "github.com/stretchr/testify/assert" +) + +func Test_ParseSimple(t *testing.T) { + r, err := os.Open("testdata/feed.json") + assert.NoError(t, err, "Could not open testdata/feed.json") + + feed, err := jsonfeed.Parse(r) + assert.NoError(t, err, "Could not parse testdata/feed.json") + + assert.Equal(t, "https://jsonfeed.org/version/1", feed.Version) + assert.Equal(t, "JSON Feed", feed.Title) + assert.Equal(t, "JSON Feed is a ...", feed.Description) + assert.Equal(t, "https://jsonfeed.org/", feed.HomePageURL) + assert.Equal(t, "https://jsonfeed.org/feed.json", feed.FeedURL) + assert.Equal(t, "This feed allows ...", feed.UserComment) + assert.Equal(t, "https://jsonfeed.org/graphics/icon.png", feed.Favicon) + assert.Equal(t, "Brent Simmons and Manton Reece", feed.Author.Name) + + assert.Equal(t, 1, len(feed.Items)) + + assert.Equal(t, "https://jsonfeed.org/2017/05/17/announcing_json_feed", feed.Items[0].ID) + assert.Equal(t, "https://jsonfeed.org/2017/05/17/announcing_json_feed", feed.Items[0].URL) + assert.Equal(t, "Announcing JSON Feed", feed.Items[0].Title) + assert.Equal(t, "

We ...", feed.Items[0].ContentHTML) + + datePublished, err := time.Parse("2006-01-02T15:04:05-07:00", "2017-05-17T08:02:12-07:00") + assert.NoError(t, err, "Could not parse timestamp") + + assert.Equal(t, datePublished, feed.Items[0].DatePublished) +} diff --git a/cmd/site/internal/jsonfeed/testdata/feed.json b/cmd/site/internal/jsonfeed/testdata/feed.json new file mode 100644 index 0000000..ad4bbe1 --- /dev/null +++ b/cmd/site/internal/jsonfeed/testdata/feed.json @@ -0,0 +1,21 @@ +{ + "version": "https://jsonfeed.org/version/1", + "title": "JSON Feed", + "description": "JSON Feed is a ...", + "home_page_url": "https://jsonfeed.org/", + "feed_url": "https://jsonfeed.org/feed.json", + "user_comment": "This feed allows ...", + "favicon": "https://jsonfeed.org/graphics/icon.png", + "author": { + "name": "Brent Simmons and Manton Reece" + }, + "items": [ + { + "id": "https://jsonfeed.org/2017/05/17/announcing_json_feed", + "url": "https://jsonfeed.org/2017/05/17/announcing_json_feed", + "title": "Announcing JSON Feed", + "content_html": "

We ...", + "date_published": "2017-05-17T08:02:12-07:00" + } + ] +} diff --git a/cmd/site/internal/middleware/metrics.go b/cmd/site/internal/middleware/metrics.go new file mode 100644 index 0000000..f9d7e0f --- /dev/null +++ b/cmd/site/internal/middleware/metrics.go @@ -0,0 +1,43 @@ +package middleware + +import ( + "net/http" + + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/promhttp" +) + +var ( + requestCounter = prometheus.NewCounterVec( + prometheus.CounterOpts{ + Name: "handler_requests_total", + Help: "Total number of request/responses by HTTP status code.", + }, []string{"handler", "code"}) + + requestDuration = prometheus.NewHistogramVec(prometheus.HistogramOpts{ + Name: "handler_request_duration", + Help: "Handler request duration.", + }, []string{"handler", "method"}) + + requestInFlight = prometheus.NewGaugeVec(prometheus.GaugeOpts{ + Name: "handler_requests_in_flight", + Help: "Current number of requests being served.", + }, []string{"handler"}) +) + +func init() { + _ = prometheus.Register(requestCounter) + _ = prometheus.Register(requestDuration) + _ = prometheus.Register(requestInFlight) +} + +// Metrics captures request duration, request count and in-flight request count +// metrics for HTTP handlers. The family field is used to discriminate handlers. +func Metrics(family string, next http.Handler) http.Handler { + return promhttp.InstrumentHandlerDuration( + requestDuration.MustCurryWith(prometheus.Labels{"handler": family}), + promhttp.InstrumentHandlerCounter(requestCounter.MustCurryWith(prometheus.Labels{"handler": family}), + promhttp.InstrumentHandlerInFlight(requestInFlight.With(prometheus.Labels{"handler": family}), next), + ), + ) +} diff --git a/cmd/site/internal/middleware/requestid.go b/cmd/site/internal/middleware/requestid.go new file mode 100644 index 0000000..6914137 --- /dev/null +++ b/cmd/site/internal/middleware/requestid.go @@ -0,0 +1,31 @@ +package middleware + +import ( + "net/http" + + "github.com/celrenheit/sandflake" + "within.website/ln" +) + +// RequestID appends a unique (sandflake) request ID to each request's +// X-Request-Id header field, much like Heroku's router does. +func RequestID(next http.Handler) http.Handler { + var g sandflake.Generator + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + id := g.Next().String() + + if rid := r.Header.Get("X-Request-Id"); rid != "" { + id = rid + "," + id + } + + ctx := ln.WithF(r.Context(), ln.F{ + "request_id": id, + }) + r = r.WithContext(ctx) + + w.Header().Set("X-Request-Id", id) + r.Header.Set("X-Request-Id", id) + + next.ServeHTTP(w, r) + }) +} diff --git a/cmd/site/main.go b/cmd/site/main.go index eaefb5d..2168dd5 100644 --- a/cmd/site/main.go +++ b/cmd/site/main.go @@ -9,9 +9,9 @@ import ( "sort" "time" - "christine.website/internal/blog" - "christine.website/internal/jsonfeed" - "christine.website/internal/middleware" + "christine.website/cmd/site/internal/blog" + "christine.website/cmd/site/internal/jsonfeed" + "christine.website/cmd/site/internal/middleware" "github.com/gorilla/feeds" "github.com/povilasv/prommod" "github.com/prometheus/client_golang/prometheus" diff --git a/cmd/site/rss.go b/cmd/site/rss.go index e03e07f..cd99bde 100644 --- a/cmd/site/rss.go +++ b/cmd/site/rss.go @@ -5,7 +5,7 @@ import ( "net/http" "time" - "christine.website/internal" + "christine.website/cmd/site/internal" "within.website/ln" "within.website/ln/opname" ) diff --git a/internal/blog/blog.go b/internal/blog/blog.go deleted file mode 100644 index b27cce5..0000000 --- a/internal/blog/blog.go +++ /dev/null @@ -1,136 +0,0 @@ -package blog - -import ( - "html/template" - "io/ioutil" - "os" - "path/filepath" - "sort" - "strings" - "time" - - "christine.website/internal/front" - "github.com/russross/blackfriday" -) - -// Post is a single blogpost. -type Post struct { - Title string `json:"title"` - Link string `json:"link"` - Summary string `json:"summary,omitifempty"` - Body string `json:"-"` - BodyHTML template.HTML `json:"body"` - Series string `json:"series"` - Tags []string `json:"tags"` - SlidesLink string `json:"slides_link"` - ImageURL string `json:"image_url"` - ThumbURL string `json:"thumb_url"` - Date time.Time - DateString string `json:"date"` -} - -// Posts implements sort.Interface for a slice of Post objects. -type Posts []Post - -func (p Posts) Series() []string { - names := map[string]struct{}{} - - for _, ps := range p { - if ps.Series != "" { - names[ps.Series] = struct{}{} - } - } - - var result []string - - for name := range names { - result = append(result, name) - } - - return result -} - -func (p Posts) Len() int { return len(p) } -func (p Posts) Less(i, j int) bool { - iDate := p[i].Date - jDate := p[j].Date - - return iDate.Unix() < jDate.Unix() -} -func (p Posts) Swap(i, j int) { p[i], p[j] = p[j], p[i] } - -// LoadPosts loads posts for a given directory. -func LoadPosts(path string, prepend string) (Posts, error) { - type postFM struct { - Title string - Date string - Series string - Tags []string - SlidesLink string `yaml:"slides_link"` - Image string - Thumb string - } - var result Posts - - err := filepath.Walk(path, func(path string, info os.FileInfo, err error) error { - if err != nil { - return err - } - - if info.IsDir() { - return nil - } - - fin, err := os.Open(path) - if err != nil { - return err - } - defer fin.Close() - - content, err := ioutil.ReadAll(fin) - if err != nil { - return err - } - - var fm postFM - remaining, err := front.Unmarshal(content, &fm) - if err != nil { - return err - } - - output := blackfriday.Run(remaining) - - const timeFormat = `2006-01-02` - date, err := time.Parse(timeFormat, fm.Date) - if err != nil { - return err - } - - fname := filepath.Base(path) - fname = strings.TrimSuffix(fname, filepath.Ext(fname)) - - p := Post{ - Title: fm.Title, - Date: date, - DateString: fm.Date, - Link: filepath.Join(prepend, fname), - Body: string(remaining), - BodyHTML: template.HTML(output), - SlidesLink: fm.SlidesLink, - Series: fm.Series, - Tags: fm.Tags, - ImageURL: fm.Image, - ThumbURL: fm.Thumb, - } - result = append(result, p) - - return nil - }) - if err != nil { - return nil, err - } - - sort.Sort(sort.Reverse(result)) - - return result, nil -} diff --git a/internal/blog/blog_test.go b/internal/blog/blog_test.go deleted file mode 100644 index 4074636..0000000 --- a/internal/blog/blog_test.go +++ /dev/null @@ -1,66 +0,0 @@ -package blog - -import ( - "testing" -) - -func TestLoadPosts(t *testing.T) { - posts, err := LoadPosts("../../blog", "blog") - if err != nil { - t.Fatal(err) - } - - for _, post := range posts { - t.Run(post.Link, post.test) - } -} - -func TestLoadTalks(t *testing.T) { - talks, err := LoadPosts("../../talks", "talks") - if err != nil { - t.Fatal(err) - } - - for _, talk := range talks { - t.Run(talk.Link, talk.test) - if talk.SlidesLink == "" { - t.Errorf("talk %s (%s) doesn't have a slides link", talk.Title, talk.DateString) - } - } -} - -func TestLoadGallery(t *testing.T) { - gallery, err := LoadPosts("../../gallery", "gallery") - if err != nil { - t.Fatal(err) - } - - for _, art := range gallery { - t.Run(art.Link, art.test) - if art.ImageURL == "" { - t.Errorf("art %s (%s) doesn't have an image link", art.Title, art.DateString) - } - if art.ThumbURL == "" { - t.Errorf("art %s (%s) doesn't have a thumbnail link", art.Title, art.DateString) - } - - } -} - -func (p Post) test(t *testing.T) { - if p.Title == "" { - t.Error("no post title") - } - - if p.DateString == "" { - t.Error("no date") - } - - if p.Link == "" { - t.Error("no link") - } - - if p.Body == "" { - t.Error("no body") - } -} diff --git a/internal/date.go b/internal/date.go deleted file mode 100644 index cc81a1c..0000000 --- a/internal/date.go +++ /dev/null @@ -1,10 +0,0 @@ -package internal - -import "time" - -const iOS13DetriFormat = `2006 M01 2` - -// IOS13Detri formats a datestamp like iOS 13 does with the Lojban locale. -func IOS13Detri(t time.Time) string { - return t.Format(iOS13DetriFormat) -} diff --git a/internal/front/LICENSE b/internal/front/LICENSE deleted file mode 100644 index e8152bb..0000000 --- a/internal/front/LICENSE +++ /dev/null @@ -1,19 +0,0 @@ -Copyright (c) 2017 TJ Holowaychuk - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. \ No newline at end of file diff --git a/internal/front/front.go b/internal/front/front.go deleted file mode 100644 index b2c7f0e..0000000 --- a/internal/front/front.go +++ /dev/null @@ -1,24 +0,0 @@ -// Package front provides YAML frontmatter unmarshalling. -package front - -import ( - "bytes" - - "gopkg.in/yaml.v2" -) - -// Delimiter. -var delim = []byte("---") - -// Unmarshal parses YAML frontmatter and returns the content. When no -// frontmatter delimiters are present the original content is returned. -func Unmarshal(b []byte, v interface{}) (content []byte, err error) { - if !bytes.HasPrefix(b, delim) { - return b, nil - } - - parts := bytes.SplitN(b, delim, 3) - content = parts[2] - err = yaml.Unmarshal(parts[1], v) - return -} diff --git a/internal/front/front_test.go b/internal/front/front_test.go deleted file mode 100644 index 42094f5..0000000 --- a/internal/front/front_test.go +++ /dev/null @@ -1,42 +0,0 @@ -package front_test - -import ( - "fmt" - "log" - - "christine.website/internal/front" -) - -var markdown = []byte(`--- -title: Ferrets -authors: - - Tobi - - Loki - - Jane ---- -Some content here, so -interesting, you just -want to keep reading.`) - -type article struct { - Title string - Authors []string -} - -func Example() { - var a article - - content, err := front.Unmarshal(markdown, &a) - if err != nil { - log.Fatalf("error unmarshalling: %s", err) - } - - fmt.Printf("%#v\n", a) - fmt.Printf("%s\n", string(content)) - // Output: - // front_test.article{Title:"Ferrets", Authors:[]string{"Tobi", "Loki", "Jane"}} - // - // Some content here, so - // interesting, you just - // want to keep reading. -} diff --git a/internal/hash.go b/internal/hash.go deleted file mode 100644 index ee333da..0000000 --- a/internal/hash.go +++ /dev/null @@ -1,14 +0,0 @@ -package internal - -import ( - "crypto/md5" - "fmt" -) - -// Hash is a simple wrapper around the MD5 algorithm implementation in the -// Go standard library. It takes in data and a salt and returns the hashed -// representation. -func Hash(data string, salt string) string { - output := md5.Sum([]byte(data + salt)) - return fmt.Sprintf("%x", output) -} diff --git a/internal/jsonfeed/.travis.yml b/internal/jsonfeed/.travis.yml deleted file mode 100644 index e872c60..0000000 --- a/internal/jsonfeed/.travis.yml +++ /dev/null @@ -1,17 +0,0 @@ -# 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/ - -language: go - -go: - - 1.8.1 - -before_install: - - go get -t -v ./... - -script: - - go test -race -coverprofile=coverage.txt -covermode=atomic - -after_success: - - bash <(curl -s https://codecov.io/bash) diff --git a/internal/jsonfeed/LICENSE b/internal/jsonfeed/LICENSE deleted file mode 100644 index e87a115..0000000 --- a/internal/jsonfeed/LICENSE +++ /dev/null @@ -1,363 +0,0 @@ -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 - "In