diff --git a/README.md b/README.md index 3c11e19..4c897d6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,10 @@ This repository is part of the [CNCF Environmental Sustainability Technical Advi ## Projects -*there are currently no projects in the repository - this section will be updated as soon as this changes* +| Name | Type | Author | +|--------------|-------------|---------------------------------------------------| +| GreenScraper | Web Scraper | William Rizzo [wrkode](https://github.com/wrkode) | + ## Contributing diff --git a/greenscraper/.gitignore b/greenscraper/.gitignore new file mode 100644 index 0000000..42cc410 --- /dev/null +++ b/greenscraper/.gitignore @@ -0,0 +1 @@ +.idea* \ No newline at end of file diff --git a/greenscraper/LICENSE.md b/greenscraper/LICENSE.md new file mode 100644 index 0000000..8165e09 --- /dev/null +++ b/greenscraper/LICENSE.md @@ -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] [Cloud Native Computing Foundation] + + 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. \ No newline at end of file diff --git a/greenscraper/Makefile b/greenscraper/Makefile new file mode 100644 index 0000000..b54f455 --- /dev/null +++ b/greenscraper/Makefile @@ -0,0 +1,25 @@ +COMMIT_ID=$(shell git rev-parse --short HEAD) +VERSION=$(shell cat VERSION) +REPO=github.com/wrkode/greenscraper + +APP_NAME=greenscraper + +all: clean build + +run: + @go run main.go + +clean: + @echo ">> Cleaning..." + @rm -rf bin + +build: clean + @echo ">> Building..." + @mkdir bin + @go build -v -o bin/$(APP_NAME) -ldflags "-X '$(REPO)/cmd.Version=$(VERSION) ($(COMMIT_ID))'" . + +install: clean build + @echo ">> Installing $(APP_NAME) in $(GOPATH)/bin..." + @cp bin/$(APP_NAME) $(GOPATH)/bin + +.PHONY: all clean build install run \ No newline at end of file diff --git a/greenscraper/README.md b/greenscraper/README.md new file mode 100644 index 0000000..4313698 --- /dev/null +++ b/greenscraper/README.md @@ -0,0 +1,21 @@ +# GreenScraper +*** +GreenScraper is a short program that will gather CNCF Conferences talks and sessions. The principal design was geared towards Sustainability specific topics. However, the introduction of a ```keywords.txt``` file, allows for additional use cases. + +## Usage + +* clone this repository and ```cd``` into the root directory. + +- Build GreenScraper: ```go build```. +- Keywords are read by GreenScraper from file ```keywords.txt```. Add the desired keywords, one by line. +- Add urls to scrape to file ```urls.txt``` +- Run GreenScraper ```./greenscraper```. +- A list of talks and links to it will be outputted to STDOUT + +## Inspiration + +GreenScraper is inspired by the work of Al-Hussein Hameed Jasim that can be found at: +https://github.com/Al-HusseinHameedJasim/green-talks-scraper/tree/main#green-talks-scraper + +*** +**Note**: GreenScraper aligns to the requirements and recommendations of Green Software Development. \ No newline at end of file diff --git a/greenscraper/cmd/main.go b/greenscraper/cmd/main.go new file mode 100644 index 0000000..c443efb --- /dev/null +++ b/greenscraper/cmd/main.go @@ -0,0 +1,88 @@ +package cmd + +import ( + "bufio" + "fmt" + "io" + "net/http" + "os" + "regexp" + "strings" + "sync" +) + +var Version = "" //yet to be implemented. + +func ReadLinesFromFile(filename string) ([]string, error) { + file, err := os.Open(filename) + if err != nil { + return nil, err + } + defer file.Close() + + var lines []string + scanner := bufio.NewScanner(file) + for scanner.Scan() { + lines = append(lines, scanner.Text()) + } + + return lines, scanner.Err() +} + +func containsAnyOfKeywords(title string, keywords []string) bool { + for _, keyword := range keywords { + if contains := strings.Contains(title, keyword); contains { + return true + } + } + return false +} + +func ProcessURL(url string, keywordRegexes []*regexp.Regexp, titleRegex *regexp.Regexp, wg *sync.WaitGroup) { + defer wg.Done() + + resp, err := http.Get(url) + if err != nil { + fmt.Printf("Failed to fetch URL %s: %v\n", url, err) + return + } + defer resp.Body.Close() + + contentBytes, err := io.ReadAll(resp.Body) + if err != nil { + fmt.Printf("Failed to read response body from URL %s: %v\n", url, err) + return + } + content := string(contentBytes) + + var talks []string + encounteredTitles := make(map[string]bool) + + for _, regex := range keywordRegexes { + matches := regex.FindAllIndex([]byte(content), -1) + + for _, match := range matches { + titleMatch := titleRegex.FindStringSubmatch(content[match[0]:]) + if len(titleMatch) > 1 { + title := titleMatch[1] + + if len(title) >= 40 && !encounteredTitles[title] && !containsBadgePickUp(title) { + encounteredTitles[title] = true + talks = append(talks, "- "+title) + } + } + } + } + + if len(talks) > 0 { + fmt.Println("Schedule link:", url) + fmt.Println("Talks:") + for _, talk := range talks { + fmt.Println(talk) + } + } +} + +func containsBadgePickUp(title string) bool { + return strings.Contains(strings.ToLower(title), "badge pick-up") +} diff --git a/greenscraper/go.mod b/greenscraper/go.mod new file mode 100644 index 0000000..de85755 --- /dev/null +++ b/greenscraper/go.mod @@ -0,0 +1,3 @@ +module github.com/cncf-tags/tag-env-tooling/greenscraper + +go 1.20 diff --git a/greenscraper/keywords.txt b/greenscraper/keywords.txt new file mode 100644 index 0000000..4113cc4 --- /dev/null +++ b/greenscraper/keywords.txt @@ -0,0 +1,7 @@ +carbon +climate +energy +green +kepler +sustainability +sustainable \ No newline at end of file diff --git a/greenscraper/main.go b/greenscraper/main.go new file mode 100644 index 0000000..36045db --- /dev/null +++ b/greenscraper/main.go @@ -0,0 +1,41 @@ +package main + +import ( + "fmt" + "github.com/cncf-tags/tag-env-tooling/greenscraper/cmd" + "regexp" + "sync" +) + +func main() { + keywords, err := cmd.ReadLinesFromFile("keywords.txt") + if err != nil { + panic(fmt.Sprintf("Failed to read keywords from file: %v", err)) + } + + urls, err := cmd.ReadLinesFromFile("urls.txt") + if err != nil { + panic(fmt.Sprintf("Failed to read URLs from file: %v", err)) + } + + titleRegex := regexp.MustCompile(".*'>(.*?).*") + keywordRegexes := make([]*regexp.Regexp, len(keywords)) + for i, keyword := range keywords { + keywordRegexes[i] = regexp.MustCompile(keyword) + } + + const concurrentLimit = 5 + sem := make(chan struct{}, concurrentLimit) // semaphore pattern for limiting concurrency + var wg sync.WaitGroup + + for _, url := range urls { + wg.Add(1) + sem <- struct{}{} // acquire a token + go func(u string) { + cmd.ProcessURL(u, keywordRegexes, titleRegex, &wg) + <-sem // release a token + }(url) + } + + wg.Wait() +} diff --git a/greenscraper/urls.txt b/greenscraper/urls.txt new file mode 100644 index 0000000..44151b1 --- /dev/null +++ b/greenscraper/urls.txt @@ -0,0 +1,79 @@ +https://kccncosschn2023.sched.com +https://kccnceu2023.sched.com +https://colocatedeventseu2023.sched.com/overview/type/ArgoCon +https://colocatedeventseu2023.sched.com/overview/type/CiliumCon +https://colocatedeventseu2023.sched.com/overview/type/Cloud+Native+Wasm+Day +https://colocatedeventseu2023.sched.com/overview/type/Istio+Day +https://colocatedeventseu2023.sched.com/overview/type/Kubernetes+on+Edge+Day +https://colocatedeventseu2023.sched.com/overview/type/Linkerd+Day +https://colocatedeventseu2023.sched.com/overview/type/Observability+Day +https://cdcongitopscon2023.sched.com +https://lssna2023.sched.com +https://osseu2023.sched.com +https://ossna2023.sched.com +https://kccncna2022.sched.com +https://backstageconna22.sched.com +https://cloudnativeebpfdayna22.sched.com +https://cloudnativesecurityconna22.sched.com +https://cloudnativetelcodayna22.sched.com +https://cloudnativewasmdayna22.sched.com +https://envoyconna22.sched.com +https://gitopsconna22.sched.com +https://kubernetesaidayna22.sched.com +https://kubernetesonedgedayna22.sched.com +https://knativeconna22.sched.com +https://kubernetesbatchdayna22.sched.com +https://openobservabilitydayna22.sched.com +https://prometheusdayna22.sched.com +https://servicemeshconna22.sched.com +https://kccnceu2022.sched.com +https://cloudnativeebpfdayeu22.sched.com +https://cloudnativesecurityconeu22.sched.com +https://cloudnativetelcodayeu22.sched.com +https://cloudnativewasmdayeu22.sched.com +https://fluentconeu22.sched.com +https://gitopsconeu22.sched.com +https://knativeconeu22.sched.com +https://kubernetesaidayeu22.sched.com +https://kubernetesbatchdayeu22.sched.com +https://kubernetesonedgedayeu22.sched.com +https://prometheusdayeu22.sched.com +https://servicemeshconeu22.sched.com +https://ossjapan2022.sched.com +https://osslatam22.sched.com +https://ossna2022.sched.com +https://osseu2022.sched.com +https://kccncosschn21.sched.com +https://kccncna2021.sched.com +https://cloudnativedevxdayna21.sched.com +https://cloudnativesecurityconna21.sched.com +https://cloudnativewasmdayna21.sched.com +https://envoyconna21.sched.com +https://fluentconna21.sched.com +https://gitopsconna21.sched.com +https://kubernetesaidayna21.sched.com +https://prodiddayspiffespirena21.sched.com +https://promconna21.sched.com +https://servicemeshconna21.sched.com +https://supplychainsecurityconna21.sched.com +https://kccnceu2021.sched.com +https://cloudnativerustdayeu21.sched.com +https://cloudnativewasmeu21.sched.com +https://cnsecuritydayeu21.sched.com +https://crossplanedayeu21.sched.com +https://fluentconeu21.sched.com +https://kubenetesaidayeu21.sched.com +https://kubenetesedgedayeu21.sched.com +https://promcononline2021.sched.com +https://servicemeshconeu21.sched.com +https://ossalsjp21.sched.com +https://osselc21.sched.com +https://kccncna20.sched.com +https://kccnceu20.sched.com +https://cnosvschina20eng.sched.com +https://cnsdna20.sched.com +https://servicemeshconeu20.sched.com +https://smcna20.sched.com +https://ossalsjp20.sched.com +https://ossna2020.sched.com +https://osseu2020.sched.com \ No newline at end of file