diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..6ed3b24 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,48 @@ +root = true + +[*] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 4 +file_header_template = \nNettify Copyright (C) 2023-2024 Aptivi\n\nThis file is part of Nettify\n\nNettify is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nNettify is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY, without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see .\n + +# IDE0060: Remove unused parameter +dotnet_diagnostic.IDE0060.severity = warning +dotnet_diagnostic.CA1822.severity = none + +[*.md] +charset = utf-8 + +[*.sh] +end_of_line = lf + +[*.resx] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 2 + +[*.csproj] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 2 + +[*.xml] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 2 + +[*.json] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 4 + +[*.yml] +end_of_line = crlf +insert_final_newline = true +indent_style = space +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1ff0c42 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,63 @@ +############################################################################### +# Set default behavior to automatically normalize line endings. +############################################################################### +* text=auto + +############################################################################### +# Set default behavior for command prompt diff. +# +# This is need for earlier builds of msysgit that does not have it on by +# default for csharp files. +# Note: This is only used by command line +############################################################################### +#*.cs diff=csharp + +############################################################################### +# Set the merge driver for project and solution files +# +# Merging from the command prompt will add diff markers to the files if there +# are conflicts (Merging from VS is not affected by the settings below, in VS +# the diff markers are never inserted). Diff markers may cause the following +# file extensions to fail to load in VS. An alternative would be to treat +# these files as binary and thus will always conflict and require user +# intervention with every merge. To do so, just uncomment the entries below +############################################################################### +#*.sln merge=binary +#*.csproj merge=binary +#*.vbproj merge=binary +#*.vcxproj merge=binary +#*.vcproj merge=binary +#*.dbproj merge=binary +#*.fsproj merge=binary +#*.lsproj merge=binary +#*.wixproj merge=binary +#*.modelproj merge=binary +#*.sqlproj merge=binary +#*.wwaproj merge=binary + +############################################################################### +# behavior for image files +# +# image files are treated as binary by default. +############################################################################### +#*.jpg binary +#*.png binary +#*.gif binary + +############################################################################### +# diff behavior for common document formats +# +# Convert binary document formats to text before diffing them. This feature +# is only available from the command line. Turn it on by uncommenting the +# entries below. +############################################################################### +#*.doc diff=astextplain +#*.DOC diff=astextplain +#*.docx diff=astextplain +#*.DOCX diff=astextplain +#*.dot diff=astextplain +#*.DOT diff=astextplain +#*.pdf diff=astextplain +#*.PDF diff=astextplain +#*.rtf diff=astextplain +#*.RTF diff=astextplain diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/ask-a-question.md new file mode 100644 index 0000000..e69df3d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ask-a-question.md @@ -0,0 +1,19 @@ +--- +name: Ask a question +about: Ask us anything about KS. +title: "[Q&A] [FeatureName] - [Question]" +labels: '' +assignees: '' + +--- + +### Type of question + +- [ ] General +- [ ] API +- [ ] Commands +- [ ] Mods +- [ ] Others + +### Question + diff --git a/.github/ISSUE_TEMPLATE/report-an-issue.md b/.github/ISSUE_TEMPLATE/report-an-issue.md new file mode 100644 index 0000000..a1f3a3b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report-an-issue.md @@ -0,0 +1,30 @@ +--- +name: Report an issue +about: Thank you for reporting a bug to us. +title: "[BUG] [featureName] - [issue]" +labels: '' +assignees: '' + +--- + +### Description + + + +### Expected behavior + + + +### Actual behavior + + + +### Steps to reproduce + +1. Open x +1. Write `yyy` +1. Observe a happening instead of z + +### Version + +Version `0.0.0 0000000000000000000000000000000000000000 main` diff --git a/.github/ISSUE_TEMPLATE/request-a-feature.md b/.github/ISSUE_TEMPLATE/request-a-feature.md new file mode 100644 index 0000000..7b1cfc2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/request-a-feature.md @@ -0,0 +1,19 @@ +--- +name: Request a feature +about: Suggest an idea to us. +title: "[ADD] [FeatureName] - [Feature]" +labels: '' +assignees: '' + +--- + +### Description of new feature + + + +### What does it add? +- [ ] New feature +- [ ] New API functions +- [ ] Others + +### Have you tried doing it? If so, attach a mod file. diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 0000000..805cd08 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,21 @@ +### Description + + + +### Expected behavior + + + +### Actual behavior + + + +### Steps to reproduce + +1. Open x +1. Write `yyy` +1. Observe a happening instead of z + +### Version + +Version `0.0.0 0000000000000000000000000000000000000000 main` diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..b3cd975 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,20 @@ +## Description + + + +## Change type + +- [ ] Bug fixes +- [ ] Performance improvements +- [ ] Feature changes +- [ ] Behavioral changes +- [ ] Other (specify) + +## Tested? + +- [ ] Yes, I have +- [ ] No, I haven't +- [ ] Not sure + +## Other changes? + diff --git a/.github/workflows/build-linux-rel.yml b/.github/workflows/build-linux-rel.yml new file mode 100644 index 0000000..d3a1b9f --- /dev/null +++ b/.github/workflows/build-linux-rel.yml @@ -0,0 +1,43 @@ +name: Build Project (Linux, Release) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + submodules: 'true' + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Release + - name: Testing + run: dotnet test --no-build --configuration Release + + notify: + + runs-on: ubuntu-latest + needs: + - build + if: ${{ always() }} + + steps: + - name: Notify + uses: nobrayner/discord-webhook@v1 + with: + github-token: ${{ secrets.G_TOKEN }} + discord-webhook: ${{ secrets.DISCORD_WEBHOOK }} + diff --git a/.github/workflows/build-linux.yml b/.github/workflows/build-linux.yml new file mode 100644 index 0000000..580ef7e --- /dev/null +++ b/.github/workflows/build-linux.yml @@ -0,0 +1,48 @@ +name: Build Project (Linux) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + submodules: 'true' + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Debug + - name: Testing + run: dotnet test --configuration Debug + - uses: actions/upload-artifact@v3 + if: success() || failure() + with: + name: txt-build + path: "Nettify/bin/Debug/" + + notify: + + runs-on: ubuntu-latest + needs: + - build + if: ${{ always() }} + + steps: + - name: Notify + uses: nobrayner/discord-webhook@v1 + with: + github-token: ${{ secrets.G_TOKEN }} + discord-webhook: ${{ secrets.DISCORD_WEBHOOK }} + diff --git a/.github/workflows/build-macos-rel.yml b/.github/workflows/build-macos-rel.yml new file mode 100644 index 0000000..09cd298 --- /dev/null +++ b/.github/workflows/build-macos-rel.yml @@ -0,0 +1,43 @@ +name: Build Project (macOS, Release) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: macos-latest + + steps: + - uses: actions/checkout@v3 + with: + submodules: 'true' + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Release + - name: Testing + run: dotnet test --no-build --configuration Release + + notify: + + runs-on: ubuntu-latest + needs: + - build + if: ${{ always() }} + + steps: + - name: Notify + uses: nobrayner/discord-webhook@v1 + with: + github-token: ${{ secrets.G_TOKEN }} + discord-webhook: ${{ secrets.DISCORD_WEBHOOK }} + diff --git a/.github/workflows/build-macos.yml b/.github/workflows/build-macos.yml new file mode 100644 index 0000000..da850b9 --- /dev/null +++ b/.github/workflows/build-macos.yml @@ -0,0 +1,48 @@ +name: Build Project (macOS) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: macos-latest + + steps: + - uses: actions/checkout@v3 + with: + submodules: 'true' + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Debug + - name: Testing + run: dotnet test --configuration Debug + - uses: actions/upload-artifact@v3 + if: success() || failure() + with: + name: txt-build + path: "Nettify/bin/Debug/" + + notify: + + runs-on: ubuntu-latest + needs: + - build + if: ${{ always() }} + + steps: + - name: Notify + uses: nobrayner/discord-webhook@v1 + with: + github-token: ${{ secrets.G_TOKEN }} + discord-webhook: ${{ secrets.DISCORD_WEBHOOK }} + diff --git a/.github/workflows/build-win-rel.yml b/.github/workflows/build-win-rel.yml new file mode 100644 index 0000000..0c41846 --- /dev/null +++ b/.github/workflows/build-win-rel.yml @@ -0,0 +1,43 @@ +name: Build Project (Windows, Release) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: windows-latest + + steps: + - uses: actions/checkout@v3 + with: + submodules: 'true' + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Release + - name: Testing + run: dotnet test --no-build --configuration Release + + notify: + + runs-on: ubuntu-latest + needs: + - build + if: ${{ always() }} + + steps: + - name: Notify + uses: nobrayner/discord-webhook@v1 + with: + github-token: ${{ secrets.G_TOKEN }} + discord-webhook: ${{ secrets.DISCORD_WEBHOOK }} + diff --git a/.github/workflows/build-win.yml b/.github/workflows/build-win.yml new file mode 100644 index 0000000..3a4d34a --- /dev/null +++ b/.github/workflows/build-win.yml @@ -0,0 +1,48 @@ +name: Build Project (Windows) + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + + runs-on: windows-latest + + steps: + - uses: actions/checkout@v3 + with: + submodules: 'true' + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Debug + - name: Testing + run: dotnet test --configuration Debug + - uses: actions/upload-artifact@v3 + if: success() || failure() + with: + name: txt-build + path: "Nettify/bin/Debug/" + + notify: + + runs-on: ubuntu-latest + needs: + - build + if: ${{ always() }} + + steps: + - name: Notify + uses: nobrayner/discord-webhook@v1 + with: + github-token: ${{ secrets.G_TOKEN }} + discord-webhook: ${{ secrets.DISCORD_WEBHOOK }} + diff --git a/.github/workflows/docgen.yml b/.github/workflows/docgen.yml new file mode 100644 index 0000000..7fbb445 --- /dev/null +++ b/.github/workflows/docgen.yml @@ -0,0 +1,31 @@ +name: KS API Documentation + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + name: "Make API Reference" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + name: Fetching the KS source + with: + submodules: 'true' + ref: ${{ github.ref }} + - uses: "nunit/docfx-action@master" + name: Generating documentation + with: + args: DocGen/docfx.json + - name: Saving changes to gh-pages + uses: peaceiris/actions-gh-pages@v3 + with: + commit_message: "Updated documentation to reflect latest changes" + personal_token: ${{ secrets.DOCGEN_TOKEN }} + publish_dir: ./docs/ + publish_branch: gh-pages diff --git a/.github/workflows/pack.yml b/.github/workflows/pack.yml new file mode 100644 index 0000000..c245934 --- /dev/null +++ b/.github/workflows/pack.yml @@ -0,0 +1,24 @@ +name: NuGet Gallery Push + +on: + release: + types: [published] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + submodules: 'true' + ref: ${{ github.ref }} + - name: Setup .NET + uses: actions/setup-dotnet@v3 + with: + dotnet-version: '8.0.x' + - name: Solution Compilation + run: dotnet build --configuration Release + - name: Package Publication + run: dotnet nuget push "Nettify/bin/Release/*.symbols.nupkg" --api-key ${{ secrets.NUGET_APIKEY }} --source "nuget.org" diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..970803e --- /dev/null +++ b/.gitignore @@ -0,0 +1,343 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +Inxi.NET.Bin/ +Inxi.NET.Tests.Bin/ +Inxi.NET.ConsoleTest.Bin/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUNIT +*.VisualState.xml +TestResult.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- Backup*.rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bcf8145 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,195 @@ +# Contributing guidelines + +First of all, thank you for contributing to our project! This kind of act is the most welcome act to help us keep running our projects the way we want them to run. All your contributions are valuable, but you need to follow these simple rules to get your contribution accepted. + +In the pull requests, we might ask you to make a few changes until we can accept them. If there's no reason for us to add your changes to the project, we might reject them altogether. + +## Following templates + +Your pull requests should follow the template. + +You should be descriptive about what your change is trying to do and what's your opinion about how it affects the whole project. Moreover, it's vital to test your changes before trying to start a pull request to ensure that there are no problems in your initial version. **Always** draft your pull requests. + +## Code guidelines + +When it comes to coding your changes, they should follow the below coding guidelines to retain the style of our projects' code. These are the below code guidelines: + +### Sorting of Fields and Properties + +Fields must come at the very beginning of each class before the properties. Between the fields and the properties and the functions, there should be an empty line. Moreover, accesibility modifiers should be sorted in the following order: + +``` +ClassName + | + |-> Public Fields + |-> Public Read-Only Fields + |-> Internal Fields + |-> Private Fields + |-> Internal Read-Only Fields + |-> Private Read-Only Fields + | + |-> Public Properties + |-> Internal Properties (rare, unless you treat them like C #macros) + | +(...) +``` + +### Sorting of Functions + +Sorting of functions is only affected by their accessibility modifiers in your code. Public functions must come before internal functions, at which the private functions come last. + +``` +(...) + | + |-> Public Functions + |-> Internal Functions + |-> Private Functions + | + --- +``` + +### Arrangement of logic in functions + +Inside functions, the arrangement of logic must be in the below order. Moreover, each part of the logic in each function must be preceded by a comment that explains why is your logic is here and a couple of necessary variables before actual logic. + +``` +ClassName +(...) + | + |-> FunctionName(int arg1, string arg2, ...) + | | + | |-> Comment explaining why (not what) is this logic here + | |-> A couple of necessary variables (optional) + | |-> Actual function logic + | | + | (...) + | +(...) +``` + +Example: + +``` +private static void PollForResize() +{ +(...) + // We need to call the WindowHeight and WindowWidth properties on the Terminal console driver, because + // this polling works for all the terminals. Other drivers that don't use the terminal may not even + // implement these two properties. + if (CurrentWindowHeight != termDriver.WindowHeight | CurrentWindowWidth != termDriver.WindowWidth) + { + ResizeDetected = true; +(...) +} +``` + +### Tabs versus Spaces + +Here we come to the argument of tabs vs spaces. Our problem with tabs is that there are systems that treat tabs as four spaces, and there are systems that treat tabs as eight spaces. Moreover, there is no universal way to accurately query the operating system for tab lengths, as such queries are up to the application handling tabs. + +We recommend that you set your IDE to use **four spaces** for each tab press. Also, don't use literal tab characters for indentation (`\t`); use four spaces. + +### Functions that do only one thing + +*This is not applicable to languages that don't support this feature* + +In C#, you can literally make a function without the opening and closing bracelets (`{ }`) if your function only contains one logic. However, you must append `=>` before the logic. Moreover, the logic should be in its own separate line with four spaces as indentation, like the following: + +``` +access_modifier [static] type SingleLogicFunctionName(string arg1, ...) => + MyLogic(arg1, ...).Modify().(...); +``` + +For example, + +``` +public static string[] GetWrappedSentences(string text, int maximumLength) => + GetWrappedSentences(text, maximumLength, 0); +``` + +### If, while, for, foreach statements that do only one thing + +*This is not applicable to languages that don't support this feature* + +In C#, you can literally make an if, while, for, and foreach statements without the opening and closing bracelets (`{ }`) if your statement only contains one logic. However, you must append `=>` before the logic. Moreover, the logic should be in its own separate line with four spaces as indentation, like the following: + +``` +if/while/for/foreach (...) + MyLogicToDo(); +``` + +For example, + +``` +// Also, compensate the \0 characters +if (text[i] == '\0') + vtSeqCompensate++; +``` + +### Naming of Public vs Internal and Private Components + +The naming must satisfy the following rules: + +* All public functions, properties, and fields must follow the Pascal Case (FunctionName) naming scheme, regardless of their purpose. +* For argument names in public, internal, and private functions, they must be named in the scheme of Camel Case (argumentName). +* Private and internal functions and properties must also follow the Pascal Case naming scheme. +* Private and internal fields must use the Camel Case naming style. +* Pascal Case should be used in class names at all times. +* You may never use the snake_case naming (this isn't Rust) or the kebab-case naming scheme (this isn't HTML) in all the components. + +To learn more about Pascal Case and Camel Case, visit [this site](https://www.freecodecamp.org/news/snake-case-vs-camel-case-vs-pascal-case-vs-kebab-case-whats-the-difference/). + +## Git commits + +We follow this conventional Git commit scheme: + +``` +Type - Attributes - Summary + +Extended Summary + +--- + +Description + +--- + +Type: Type +Breaking: Yes/No +Documentation Required: Yes/No +Part: 1/1 +``` + +For types, you should select exactly one type from the following types: + +``` +add: for additions +fix: for fixes +rem: for removals +imp: for improvements +ref: for refactors +upd: for library updates +doc: for documentation updates +``` + +Additionally, attributes are optional and can be specified. Multiple attributes should be separated with the pipe character (`|`). However, there are special cases that you may need to handle when you're committing your changes to your pull request: + +* If documentation is required (i.e. your commit requires documentation on GitBook and you've specified `doc`), change the `Documentation Required` part to `Yes`, otherwise, `No`. +* If this commit includes breaking changes (i.e. you've specified `brk`), change the `Breaking` part to `Yes`, otherwise, `No`. +* If this commit is a part of the commit series, specify `prt` and change the `Part` field where it says `1/1` to the current and the total parts in this format: `current/total`. Total parts must be accurate, and the title should stay the same as any former commits in the series. + +These are the attributes we officially support: + +``` +brk: for breaking changes +sec: for security +prf: for performance improvements +reg: for regression fixes +doc: for documentation requirement +ptp: for prototyping +prt: for commit series (PartNum is required) +``` + +## Engagement with the Community + +Thank you for your contribution to our project, but in order for this contribution to be flawless, you must be respectful to all other developers of the projects and the users in general, regardless of whether there is a fight or a heated discussion going on. Try to keep it civil during fights and don't use personal attacks, threats of any kind, derogatory and racist remarks against people or groups of any race, ethnicity, religion, or group, and explicit words (like swearing) to try to solve any disagreement with anyone, including the developers of the project. diff --git a/DocGen/.gitignore b/DocGen/.gitignore new file mode 100644 index 0000000..2a64487 --- /dev/null +++ b/DocGen/.gitignore @@ -0,0 +1,6 @@ +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +reference \ No newline at end of file diff --git a/DocGen/docfx.json b/DocGen/docfx.json new file mode 100644 index 0000000..6b32ae5 --- /dev/null +++ b/DocGen/docfx.json @@ -0,0 +1,49 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ "Nettify/**.csproj" ], + "src": ".." + } + ], + "dest": "api", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "filterConfig.yml" + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml", + "index.md", + "toc.yml" + ] + } + ], + "resource": [ + { + "files": [ "images/**" ] + } + ], + "dest": "../docs", + "globalMetadata": { + "_appTitle": "Nettify API - Aptivi", + "_enableSearch": true + }, + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ "default" ], + "postProcessors": [], + "markdownEngineName": "markdig", + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": false, + "sitemap": { + "baseUrl": "https://aptivi.github.io/Nettify/" + } + } +} diff --git a/DocGen/filterConfig.yml b/DocGen/filterConfig.yml new file mode 100644 index 0000000..c1e4d00 --- /dev/null +++ b/DocGen/filterConfig.yml @@ -0,0 +1,17 @@ +apiRules: +- exclude: + # inherited members from Form + uidRegex: ^System\.Windows\.Forms\.Form\..*$ + type: Member +- exclude: + # inherited members from Control + uidRegex: ^System\.Windows\.Forms\.Control\..*$ + type: Member +- exclude: + # mentioning types from System.* namespace + uidRegex: ^System\..*$ + type: Type +- exclude: + # mentioning types from Microsoft.* namespace + uidRegex: ^Microsoft\..*$ + type: Type \ No newline at end of file diff --git a/DocGen/index.md b/DocGen/index.md new file mode 100644 index 0000000..6e5333b --- /dev/null +++ b/DocGen/index.md @@ -0,0 +1,21 @@ +## What is Nettify? + +Nettify is a library that serves as a collection of online tools. It allows you to get live information from varying types, such as the weather forecast. + +## What is this web page? + +This webpage is an API documentation for mod developers to be used as reference. It constantly gets updated as we push the updates to the main and servicing versions of this project. + +If you still intend to use a documentation specific to your preferred version of Nettify, you may refer to the [releases](https://github.com/Aptivi/Nettify/releases) page of the project and download the attached `-doc.rar` file. + +To get started using the documentation, select `API Documentation` from the top menu and select a namespace to get a clear overview of the API. + +## Feedback + +If you wish to leave feedback to us about this API reference website, use the [issue tracker](https://github.com/Aptivi/Nettify/issues) of the project. + +If you wish to contribute to the documentation of the API, go to the project source code and make your improvements there on a draft [Pull Request](https://github.com/Aptivi/Nettify/pulls); we don't support override files that are made by clicking on `Improve this doc`. + +Any meaningful contributions are welcome. + +Copyright (c) 2022 Aptivi. All rights reserved. diff --git a/DocGen/toc.yml b/DocGen/toc.yml new file mode 100644 index 0000000..3b07592 --- /dev/null +++ b/DocGen/toc.yml @@ -0,0 +1,4 @@ +- name: Home + href: index.md +- name: API Documentation + href: api/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..382eb97 --- /dev/null +++ b/Makefile @@ -0,0 +1,15 @@ +OUTPUTS = Nettify.*/bin Nettify.*/obj Nettify/bin Nettify/obj + +.PHONY: all + +# General use + +all: all-online + +all-online: + $(MAKE) -C tools invoke-build + +clean: + rm -rf $(OUTPUTS) + +# This makefile is just a wrapper for tools scripts. diff --git a/Nettify.Demo/Entry.cs b/Nettify.Demo/Entry.cs new file mode 100644 index 0000000..ef22eb4 --- /dev/null +++ b/Nettify.Demo/Entry.cs @@ -0,0 +1,35 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using Nettify.Demo.Fixtures; +using System; + +namespace Nettify.Demo +{ + internal class Entry + { + static void Main(string[] args) + { + // Get the fixture name from argument and run it + string chosenFixture = args.Length == 0 ? "Forecast" : args[0]; + Console.WriteLine($"Fixture to be tested: {chosenFixture}\n"); + FixtureManager.GetFixtureFromName(chosenFixture).RunFixture(); + } + } +} diff --git a/Nettify.Demo/Fixtures/Cases/Forecast.cs b/Nettify.Demo/Fixtures/Cases/Forecast.cs new file mode 100644 index 0000000..2b2d5c1 --- /dev/null +++ b/Nettify.Demo/Fixtures/Cases/Forecast.cs @@ -0,0 +1,62 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using Nettify.Weather; +using System; + +namespace Nettify.Demo.Fixtures.Cases +{ + internal class Forecast : IFixture + { + public string FixtureID => "Forecast"; + public void RunFixture() + { + string ApiKey; + string StringID; + WeatherForecastInfo forecastInfo; + bool IsNumeric; + + // ID or name + Console.Write("Enter city ID or name: "); + StringID = Console.ReadLine(); + IsNumeric = long.TryParse(StringID, out long FinalID); + + // API key + Console.Write("Enter API key: "); + ApiKey = Console.ReadLine(); + + // Get weather info + if (IsNumeric) + forecastInfo = WeatherForecast.GetWeatherInfo(FinalID, ApiKey, UnitMeasurement.Metric); + else + forecastInfo = WeatherForecast.GetWeatherInfo(StringID, ApiKey, UnitMeasurement.Metric); + + // Print the weather information + Console.WriteLine("City ID: " + forecastInfo.CityID); + Console.WriteLine("City Name: " + forecastInfo.CityName); + Console.WriteLine("Weather State: " + forecastInfo.Weather); + Console.WriteLine("Temperature: " + forecastInfo.Temperature); + Console.WriteLine("Feels Like: " + forecastInfo.FeelsLike); + Console.WriteLine("Pressure: " + forecastInfo.Pressure); + Console.WriteLine("Humidity: " + forecastInfo.Humidity); + Console.WriteLine("Wind Speed: " + forecastInfo.WindSpeed); + Console.WriteLine("Wind Direction: " + forecastInfo.WindDirection); + } + } +} diff --git a/Nettify.Demo/Fixtures/Cases/RssFeedViewer.cs b/Nettify.Demo/Fixtures/Cases/RssFeedViewer.cs new file mode 100644 index 0000000..0c434e5 --- /dev/null +++ b/Nettify.Demo/Fixtures/Cases/RssFeedViewer.cs @@ -0,0 +1,50 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using Nettify.Rss.Instance; +using System; + +namespace Nettify.Demo.Fixtures.Cases +{ + internal class RssFeedViewer : IFixture + { + public string FixtureID => "RssFeedViewer"; + public void RunFixture() + { + // Prompt for RSS URL + Console.Write("Enter RSS URL: "); + string address = Console.ReadLine(); + + // Populate the RSS info + var feed = new RSSFeed(address, RSSFeedType.Infer); + feed.Refresh(); + Console.WriteLine("Title: {0}", feed.FeedTitle); + Console.WriteLine("Description: {0}", feed.FeedDescription); + Console.WriteLine("URL: {0}\n", feed.FeedUrl); + + // Populate the article info + foreach (RSSArticle article in feed.FeedArticles) + { + Console.WriteLine(" Title: {0}", article.ArticleTitle); + Console.WriteLine(" Description: {0}", article.ArticleDescription); + Console.WriteLine(" URL: {0}\n", article.ArticleLink); + } + } + } +} diff --git a/Nettify.Demo/Fixtures/Cases/ShoutCastStats.cs b/Nettify.Demo/Fixtures/Cases/ShoutCastStats.cs new file mode 100644 index 0000000..db6f9e3 --- /dev/null +++ b/Nettify.Demo/Fixtures/Cases/ShoutCastStats.cs @@ -0,0 +1,111 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using Nettify.Radio; +using System; + +namespace Nettify.Demo.Fixtures.Cases +{ + internal class ShoutCastStats : IFixture + { + public string FixtureID => "ShoutCastStats"; + public void RunFixture() + { + // Prompt for server address and port + Console.Write("Enter server address for SHOUTcast: "); + string address = Console.ReadLine(); + Console.Write("Enter server port for SHOUTcast: "); + string port = Console.ReadLine(); + + // Check the port number + bool isNumeric = int.TryParse(port, out int portInt); + if (!isNumeric) + { + Console.WriteLine("Invalid port number."); + return; + } + + try + { + // Parse the address and the port + if (!address.Contains(Uri.SchemeDelimiter)) + address = Uri.UriSchemeHttps + Uri.SchemeDelimiter + address; + bool UseSecure = address.Contains("https://"); + Console.WriteLine("Getting information about stream {0}:{1}...", address, portInt); + + // Get the stream info + ShoutcastServer ParsedServer = new(address, portInt, UseSecure); + ParsedServer.Refresh(); + + // Print the server information + Console.WriteLine($"Host: {ParsedServer.ServerHost}"); + Console.WriteLine($"Port: {ParsedServer.ServerPort}"); + Console.WriteLine($"URL: {ParsedServer.ServerHostFull}"); + Console.WriteLine($"Secure protocol: {ParsedServer.ServerHttps}"); + Console.WriteLine($"Server version: {ParsedServer.ServerVersion}"); + Console.WriteLine($"Total streams: {ParsedServer.TotalStreams}"); + Console.WriteLine($"Active streams: {ParsedServer.ActiveStreams}"); + Console.WriteLine($"Current listeners: {ParsedServer.CurrentListeners}"); + Console.WriteLine($"Peak listeners: {ParsedServer.PeakListeners}"); + Console.WriteLine($"Max listeners: {ParsedServer.MaxListeners}"); + Console.WriteLine($"Unique listeners: {ParsedServer.UniqueListeners}"); + Console.WriteLine($"Average time (s): {ParsedServer.AverageTime}"); + Console.WriteLine($"Average time (span): {ParsedServer.AverageTimeSpan}"); + + // Print the stream information + foreach (StreamInfo stream in ParsedServer.Streams) + { + Console.WriteLine("---------------------------------------"); + Console.WriteLine($"Stream ID: {stream.StreamId}"); + Console.WriteLine($"Stream title: {stream.StreamTitle}"); + Console.WriteLine($"Current song: {stream.SongTitle}"); + Console.WriteLine($"Current listeners: {stream.CurrentListeners}"); + Console.WriteLine($"Peak listeners: {stream.PeakListeners}"); + Console.WriteLine($"Max listeners: {stream.MaxListeners}"); + Console.WriteLine($"Unique listeners: {stream.UniqueListeners}"); + Console.WriteLine($"Average time (s): {stream.AverageTime}"); + Console.WriteLine($"Average time (span): {stream.AverageTimeSpan}"); + Console.WriteLine($"Stream genre: {stream.StreamGenre}"); + Console.WriteLine($"Stream homepage: {stream.StreamHomepage}"); + Console.WriteLine($"Stream hits: {stream.StreamHits}"); + Console.WriteLine($"Stream status: {stream.StreamStatus}"); + Console.WriteLine($"Backup status: {stream.BackupStatus}"); + Console.WriteLine($"Stream listed: {stream.StreamListed}"); + Console.WriteLine($"Stream path: {stream.StreamPath}"); + Console.WriteLine($"Stream uptime (s): {stream.StreamUptime}"); + Console.WriteLine($"Stream uptime (span): {stream.StreamUptimeSpan}"); + Console.WriteLine($"Stream bitrate: {stream.BitRate}"); + Console.WriteLine($"Stream sample rate: {stream.SampleRate}"); + Console.WriteLine($"MIME info: {stream.MimeInfo}"); + } + Console.WriteLine("---------------------------------------"); + } + catch (Exception ex) + { + Console.WriteLine("Error trying to get information for the server: {0}", ex.Message); + Console.WriteLine(ex.StackTrace); + if (ex.InnerException != null) + { + Console.WriteLine("If this is a problem in this component of Nettify, report it: {0}", ex.InnerException.Message); + Console.WriteLine(ex.InnerException.StackTrace); + } + } + } + } +} diff --git a/Nettify.Demo/Fixtures/FixtureManager.cs b/Nettify.Demo/Fixtures/FixtureManager.cs new file mode 100644 index 0000000..707e858 --- /dev/null +++ b/Nettify.Demo/Fixtures/FixtureManager.cs @@ -0,0 +1,63 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using Nettify.Demo.Fixtures.Cases; +using System; +using System.Linq; + +namespace Nettify.Demo.Fixtures +{ + internal static class FixtureManager + { + internal static IFixture[] fixtures = + [ + // Forecast + new Forecast(), + + // RSS + new RssFeedViewer(), + + // SHOUTcast + new ShoutCastStats(), + ]; + + internal static IFixture GetFixtureFromName(string name) + { + if (DoesFixtureExist(name)) + { + var detectedFixtures = fixtures.Where((fixture) => fixture.FixtureID == name).ToArray(); + return detectedFixtures[0]; + } + else + throw new Exception( + "Fixture doesn't exist. Available fixtures:\n" + + " - " + string.Join("\n - ", GetFixtureNames()) + ); + } + + internal static bool DoesFixtureExist(string name) + { + var detectedFixtures = fixtures.Where((fixture) => fixture.FixtureID == name); + return detectedFixtures.Any(); + } + + internal static string[] GetFixtureNames() => + fixtures.Select((fixture) => fixture.FixtureID).ToArray(); + } +} diff --git a/Nettify.Demo/Fixtures/IFixture.cs b/Nettify.Demo/Fixtures/IFixture.cs new file mode 100644 index 0000000..94648ac --- /dev/null +++ b/Nettify.Demo/Fixtures/IFixture.cs @@ -0,0 +1,27 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +namespace Nettify.Demo.Fixtures +{ + internal interface IFixture + { + string FixtureID { get; } + void RunFixture(); + } +} diff --git a/Nettify.Demo/Nettify.Demo.csproj b/Nettify.Demo/Nettify.Demo.csproj new file mode 100644 index 0000000..e014720 --- /dev/null +++ b/Nettify.Demo/Nettify.Demo.csproj @@ -0,0 +1,12 @@ + + + + Exe + net8.0 + + + + + + + diff --git a/Nettify.Demo/Properties/launchSettings.json b/Nettify.Demo/Properties/launchSettings.json new file mode 100644 index 0000000..2b860d4 --- /dev/null +++ b/Nettify.Demo/Properties/launchSettings.json @@ -0,0 +1,20 @@ +{ + "profiles": { + "WSL": { + "commandName": "WSL2", + "distributionName": "" + }, + "Nettify.Demo - Forecast": { + "commandName": "Project", + "commandLineArgs": "Forecast" + }, + "Nettify.Demo - RssFeedViewer": { + "commandName": "Project", + "commandLineArgs": "RssFeedViewer" + }, + "Nettify.Demo - ShoutCastStats": { + "commandName": "Project", + "commandLineArgs": "ShoutCastStats" + } + } +} \ No newline at end of file diff --git a/Nettify.sln b/Nettify.sln new file mode 100644 index 0000000..3c50f48 --- /dev/null +++ b/Nettify.sln @@ -0,0 +1,31 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.8.34330.188 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Nettify", "Nettify\Nettify.csproj", "{62C25E4C-7941-4655-9CDB-A22E2FEE4B2D}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Nettify.Demo", "Nettify.Demo\Nettify.Demo.csproj", "{72CD0859-837E-4022-8B52-F4E7C212143B}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {62C25E4C-7941-4655-9CDB-A22E2FEE4B2D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {62C25E4C-7941-4655-9CDB-A22E2FEE4B2D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {62C25E4C-7941-4655-9CDB-A22E2FEE4B2D}.Release|Any CPU.ActiveCfg = Release|Any CPU + {62C25E4C-7941-4655-9CDB-A22E2FEE4B2D}.Release|Any CPU.Build.0 = Release|Any CPU + {72CD0859-837E-4022-8B52-F4E7C212143B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {72CD0859-837E-4022-8B52-F4E7C212143B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {72CD0859-837E-4022-8B52-F4E7C212143B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {72CD0859-837E-4022-8B52-F4E7C212143B}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {A90B7DED-5D5D-4422-8B98-5D71FBF96268} + EndGlobalSection +EndGlobal diff --git a/Nettify/Nettify.csproj b/Nettify/Nettify.csproj new file mode 100644 index 0000000..1a12f31 --- /dev/null +++ b/Nettify/Nettify.csproj @@ -0,0 +1,57 @@ + + + + netstandard2.0 + True + True + True + 1.0.0 + Aptivi + Aptivi Corp. + Text tools + Copyright (c) 2023-2024 Aptivi. + https://github.com/Aptivi/Nettify + https://github.com/Aptivi/Nettify + git + dictionary;api;free;csharp;visualbasic;word;meaning;definition;text;tools;library + GPL-3.0-or-later + True + 1.0.0 + OfficialAppIcon-Nettify-512.png + README.md + Nettify + latest + True + ..\aptivi_snk.snk + + + + + True + \ + + + + + true + true + + + + + + + + + + + True + \ + + + + + + + + diff --git a/Nettify/OfficialAppIcon-Nettify-512.png b/Nettify/OfficialAppIcon-Nettify-512.png new file mode 100644 index 0000000..b7a189c Binary files /dev/null and b/Nettify/OfficialAppIcon-Nettify-512.png differ diff --git a/Nettify/Radio/ShoutcastServer.cs b/Nettify/Radio/ShoutcastServer.cs new file mode 100644 index 0000000..a9a1ae5 --- /dev/null +++ b/Nettify/Radio/ShoutcastServer.cs @@ -0,0 +1,233 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using System; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; +using HtmlAgilityPack; +using System.Net.Http; +using System.Threading.Tasks; + +namespace Nettify.Radio +{ + /// + /// A Shoutcast server + /// + public class ShoutcastServer + { + private ShoutcastVersion serverVersion; + private int totalStreams; + private int activeStreams; + private int currentListeners; + private int peakListeners; + private int maxListeners; + private int uniqueListeners; + private int averageTime; + private readonly List streams = []; + internal JToken streamToken; + internal HtmlDocument streamHtmlToken = new(); + internal HttpClient client = new(); + + /// + /// Server IP address + /// + public string ServerHost { get; } + /// + /// Server port + /// + public int ServerPort { get; } + /// + /// Server IP address with port + /// + public string ServerHostFull => ServerHost + ":" + ServerPort; + /// + /// Whether the Shoutcast server is using HTTPS or not + /// + public bool ServerHttps { get; } + /// + /// Server version (1.x, 2.x) + /// + public ShoutcastVersion ServerVersion => serverVersion; + /// + /// Total number of streams in the server + /// + public int TotalStreams => totalStreams; + /// + /// Active streams in the server + /// + public int ActiveStreams => activeStreams; + /// + /// How many people are listening to the server at this time? + /// + public int CurrentListeners => currentListeners; + /// + /// How many listeners did the server ever get at peak times? + /// + public int PeakListeners => peakListeners; + /// + /// How many people can listen to the server? + /// + public int MaxListeners => maxListeners; + /// + /// How many unique listeners are there? + /// + public int UniqueListeners => uniqueListeners; + /// + /// Average time on any active listener connections in seconds + /// + public int AverageTime => averageTime; + /// + /// Average time on any active listener connections in the time span + /// + public TimeSpan AverageTimeSpan => TimeSpan.FromSeconds(AverageTime); + /// + /// Available streams and their statistics + /// + public List Streams => streams; + + /// + /// Connects to the Shoutcast server and gets the information + /// + /// Server host name + /// Server port + /// Whether to use the HTTPS protocol or not + public ShoutcastServer(string serverHost, int serverPort, bool useHttps) + { + // Check to see if we're dealing with the secure Shoutcast server + ServerHost = serverHost; + if (useHttps) + { + if (!serverHost.Contains(Uri.SchemeDelimiter)) + ServerHost = $"https://{serverHost}"; + } + else + { + if (!serverHost.Contains(Uri.SchemeDelimiter)) + ServerHost = $"http://{serverHost}"; + } + ServerHttps = useHttps; + + // Install the values initially + ServerPort = serverPort; + serverVersion = ShoutcastVersion.v2; + } + + /// + /// Refreshes the statistics + /// + public void Refresh() + { + try + { + InitializeStatsAsync().Wait(); + + // Determine version of Shoutcast + if (serverVersion == ShoutcastVersion.v1) + FinalizeShoutcastV1(); + else + FinalizeShoutcastV2(); + } + catch (Exception ex) + { + throw new ShoutcastServerException($"Failed to parse Shoutcast server {ServerHost}. More information can be found in the inner exception.", ex); + } + } + + /// + /// Refreshes the statistics + /// + public async Task RefreshAsync() + { + try + { + await InitializeStatsAsync(); + + // Determine version of Shoutcast + if (serverVersion == ShoutcastVersion.v1) + FinalizeShoutcastV1(); + else + FinalizeShoutcastV2(); + } + catch (Exception ex) + { + throw new ShoutcastServerException($"Failed to parse Shoutcast server {ServerHost}. More information can be found in the inner exception.", ex); + } + } + + internal async Task InitializeStatsAsync() + { + // Use the full address to download the statistics. Note that Shoutcast v2 streams will use the /statistics directory, which provides + // more information than /7.html. If we're dealing with the first version, or if /statistics is disabled for some reason, fallback to + // /7.html + Uri statisticsUri = new(ServerHostFull + "/statistics?json=1"); + Uri fallbackUri = new(ServerHostFull + "/7.html"); + string serverResponse = await client.GetStringAsync(statisticsUri); + + // Shoutcast v1.x doesn't have /statistics... + if (serverResponse.Contains("Invalid resource")) + { + // Detected v1. Fallback to /7.html + serverVersion = ShoutcastVersion.v1; + serverResponse = await client.GetStringAsync(fallbackUri); + streamHtmlToken.LoadHtml(serverResponse); + } + else + streamToken = JToken.Parse(serverResponse); + } + + internal void FinalizeShoutcastV1() + { + // Shoutcast version v1.x, so use the html fallback token. Response values are as follows: + // currentlisteners,streamstatus(S),peaklisteners,maxlisteners,uniquelisteners,bitrate(S),songtitle(S) + // First, deal with the server settings. + string[] response = streamHtmlToken.DocumentNode.SelectSingleNode("body").InnerText.Split(','); + currentListeners = Convert.ToInt32(response[0]); + peakListeners = Convert.ToInt32(response[2]); + maxListeners = Convert.ToInt32(response[3]); + uniqueListeners = Convert.ToInt32(response[4]); + + // Then, deal with the stream settings + StreamInfo streamInfo = new(this, null); + streams.Clear(); + streams.Add(streamInfo); + } + + internal void FinalizeShoutcastV2() + { + // Shoutcast version v2.x, so use the JToken. + // Use all the keys in the first object except the "streams" and "version", where we'd later use the former in StreamInfo to install + // all the streams into the new class instance. + totalStreams = (int)streamToken["totalstreams"]; + activeStreams = (int)streamToken["activestreams"]; + currentListeners = (int)streamToken["currentlisteners"]; + peakListeners = (int)streamToken["peaklisteners"]; + maxListeners = (int)streamToken["maxlisteners"]; + uniqueListeners = (int)streamToken["uniquelisteners"]; + averageTime = (int)streamToken["averagetime"]; + + // Now, deal with the stream settings. + streams.Clear(); + foreach (JToken stream in streamToken["streams"]) + { + StreamInfo streamInfo = new(this, stream); + streams.Add(streamInfo); + } + } + } +} diff --git a/Nettify/Radio/ShoutcastServerException.cs b/Nettify/Radio/ShoutcastServerException.cs new file mode 100644 index 0000000..aadf80c --- /dev/null +++ b/Nettify/Radio/ShoutcastServerException.cs @@ -0,0 +1,48 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using System; + +namespace Nettify.Radio +{ + /// + /// Happens when the error in the server has occurred + /// + public class ShoutcastServerException : Exception + { + /// + /// Throws the server exception + /// + public ShoutcastServerException() { } + /// + /// Throws the server exception + /// + public ShoutcastServerException(string message) : base(message) { } + /// + /// Throws the server exception + /// + public ShoutcastServerException(string message, Exception inner) : base(message, inner) { } + /// + /// Throws the server exception + /// + protected ShoutcastServerException( + System.Runtime.Serialization.SerializationInfo info, + System.Runtime.Serialization.StreamingContext context) : base(info, context) { } + } +} diff --git a/Nettify/Radio/ShoutcastStreamParseException.cs b/Nettify/Radio/ShoutcastStreamParseException.cs new file mode 100644 index 0000000..9a61b35 --- /dev/null +++ b/Nettify/Radio/ShoutcastStreamParseException.cs @@ -0,0 +1,48 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using System; + +namespace Nettify.Radio +{ + /// + /// Happens when the error in parsing the stream has occurred + /// + public class ShoutcastStreamParseException : Exception + { + /// + /// Throws the stream parse exception + /// + public ShoutcastStreamParseException() { } + /// + /// Throws the stream parse exception + /// + public ShoutcastStreamParseException(string message) : base(message) { } + /// + /// Throws the stream parse exception + /// + public ShoutcastStreamParseException(string message, Exception inner) : base(message, inner) { } + /// + /// Throws the stream parse exception + /// + protected ShoutcastStreamParseException( + System.Runtime.Serialization.SerializationInfo info, + System.Runtime.Serialization.StreamingContext context) : base(info, context) { } + } +} diff --git a/Nettify/Radio/ShoutcastVersion.cs b/Nettify/Radio/ShoutcastVersion.cs new file mode 100644 index 0000000..a5da16e --- /dev/null +++ b/Nettify/Radio/ShoutcastVersion.cs @@ -0,0 +1,36 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +namespace Nettify.Radio +{ + /// + /// Enumeration for the Shoutcast version + /// + public enum ShoutcastVersion + { + /// + /// Shoutcast version 1.x + /// + v1, + /// + /// Shoutcast version 2.x + /// + v2 + } +} diff --git a/Nettify/Radio/StreamInfo.cs b/Nettify/Radio/StreamInfo.cs new file mode 100644 index 0000000..5d8004b --- /dev/null +++ b/Nettify/Radio/StreamInfo.cs @@ -0,0 +1,211 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using System; +using Newtonsoft.Json.Linq; + +namespace Nettify.Radio +{ + /// + /// Shoutcast stream information + /// + public class StreamInfo + { + private readonly int currentListeners; + private readonly int peakListeners; + private readonly int maxListeners; + private readonly int uniqueListeners; + private readonly int averageTime; + private readonly int streamId; + private readonly string streamGenre; + private readonly string streamGenre2; + private readonly string streamGenre3; + private readonly string streamGenre4; + private readonly string streamGenre5; + private readonly string streamHomepage; + private readonly string streamTitle; + private readonly string songTitle; + private readonly long streamHits; + private readonly int streamStatus; + private readonly int backupStatus; + private readonly bool streamListed; + private readonly string streamPath; + private readonly long streamUptime; + private readonly int bitRate; + private readonly int sampleRate; + private readonly string mimeInfo; + + /// + /// Stream ID starting from number one (1) + /// + public int StreamId => streamId; + /// + /// How many people are listening to the stream at this time? + /// + public int CurrentListeners => currentListeners; + /// + /// How many listeners did the stream ever get at peak times? + /// + public int PeakListeners => peakListeners; + /// + /// How many people can listen to the stream? + /// + public int MaxListeners => maxListeners; + /// + /// How many unique listeners are there? + /// + public int UniqueListeners => uniqueListeners; + /// + /// Average time on any active listener connections in seconds + /// + public int AverageTime => averageTime; + /// + /// Average time on any active listener connections in the time span + /// + public TimeSpan AverageTimeSpan => TimeSpan.FromSeconds(averageTime); + /// + /// The stream genre + /// + public string StreamGenre => streamGenre; + /// + /// The second stream genre + /// + public string StreamGenre2 => streamGenre2; + /// + /// The third stream genre + /// + public string StreamGenre3 => streamGenre3; + /// + /// The fourth stream genre + /// + public string StreamGenre4 => streamGenre4; + /// + /// The fifth stream genre + /// + public string StreamGenre5 => streamGenre5; + /// + /// Link to the stream homepage + /// + public string StreamHomepage => streamHomepage; + /// + /// Stream title + /// + public string StreamTitle => streamTitle; + /// + /// Song title + /// + public string SongTitle => songTitle; + /// + /// Stream hits + /// + public long StreamHits => streamHits; + /// + /// Stream status + /// + public int StreamStatus => streamStatus; + /// + /// Backup status + /// + public int BackupStatus => backupStatus; + /// + /// Is the stream listed? + /// + public bool StreamListed => streamListed; + /// + /// Path to stream + /// + public string StreamPath => streamPath; + /// + /// Stream uptime in seconds + /// + public long StreamUptime => streamUptime; + /// + /// Stream uptime in the time span + /// + public TimeSpan StreamUptimeSpan => TimeSpan.FromSeconds(StreamUptime); + /// + /// Stream bitrate in kbps + /// + public int BitRate => bitRate; + /// + /// Sampling rate in Hz + /// + public int SampleRate => sampleRate; + /// + /// MIME info for stream, usually audio/mpeg. + /// + public string MimeInfo => mimeInfo; + + /// + /// Makes a new stream information which has all the streams + /// + /// Shoutcast server class instance + /// Individual stream token + internal StreamInfo(ShoutcastServer server, JToken stream) + { + try + { + // Determine version of Shoutcast + if (server.ServerVersion == ShoutcastVersion.v1) + { + // Shoutcast version v1.x, so use the html fallback token. + string[] response = server.streamHtmlToken.DocumentNode.SelectSingleNode("body").InnerText.Split(','); + currentListeners = Convert.ToInt32(response[0]); + streamStatus = Convert.ToInt32(response[1]); + peakListeners = Convert.ToInt32(response[2]); + maxListeners = Convert.ToInt32(response[3]); + uniqueListeners = Convert.ToInt32(response[4]); + bitRate = Convert.ToInt32(response[5]); + songTitle = response[6]; + } + else + { + // Shoutcast version v2.x, so use the JToken. + streamId = (int)stream["id"]; + currentListeners = (int)stream["currentlisteners"]; + peakListeners = (int)stream["peaklisteners"]; + maxListeners = (int)stream["maxlisteners"]; + uniqueListeners = (int)stream["uniquelisteners"]; + averageTime = (int)stream["averagetime"]; + streamGenre = (string)stream["servergenre"]; + streamGenre2 = (string)stream["servergenre2"]; + streamGenre3 = (string)stream["servergenre3"]; + streamGenre4 = (string)stream["servergenre4"]; + streamGenre5 = (string)stream["servergenre5"]; + streamHomepage = (string)stream["serverurl"]; + streamTitle = (string)stream["servertitle"]; + songTitle = (string)stream["songtitle"]; + streamHits = (int)stream["streamhits"]; + streamStatus = (int)stream["streamstatus"]; + backupStatus = (int)stream["backupstatus"]; + streamListed = (bool)stream["streamlisted"]; + streamPath = (string)stream["streampath"]; + streamUptime = (int)stream["streamuptime"]; + bitRate = (int)stream["bitrate"]; + sampleRate = (int)stream["samplerate"]; + mimeInfo = (string)stream["content"]; + } + } + catch (Exception ex) + { + throw new ShoutcastStreamParseException($"Failed to parse Shoutcast stream ID {streamId}. More information can be found in the inner exception.", ex); + } + } + } +} diff --git a/Nettify/Rss/Instance/RSSArticle.cs b/Nettify/Rss/Instance/RSSArticle.cs new file mode 100644 index 0000000..b573d7a --- /dev/null +++ b/Nettify/Rss/Instance/RSSArticle.cs @@ -0,0 +1,76 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using System.Collections.Generic; +using System.Xml; + +namespace Nettify.Rss.Instance +{ + /// + /// RSS article instance + /// + public class RSSArticle + { + + private readonly string articleTitle; + private readonly string articleLink; + private readonly string articleDescription; + private readonly Dictionary articleVariables; + + /// + /// RSS Article Title + /// + public string ArticleTitle + => articleTitle; + + /// + /// RSS Article Link + /// + public string ArticleLink + => articleLink; + + /// + /// RSS Article Descirption + /// + public string ArticleDescription + => articleDescription; + + /// + /// RSS Article Parameters + /// + public Dictionary ArticleVariables + => articleVariables; + + /// + /// Makes a new instance of RSS article + /// + /// Article title + /// Link to article + /// Article description + /// Article variables as s + internal RSSArticle(string ArticleTitle, string ArticleLink, string ArticleDescription, Dictionary ArticleVariables) + { + articleTitle = !string.IsNullOrWhiteSpace(ArticleTitle) ? ArticleTitle.Trim() : ""; + articleLink = !string.IsNullOrWhiteSpace(ArticleLink) ? ArticleLink.Trim() : ""; + articleDescription = !string.IsNullOrWhiteSpace(ArticleDescription) ? ArticleDescription.Trim() : ""; + articleVariables = ArticleVariables; + } + + } +} diff --git a/Nettify/Rss/Instance/RSSException.cs b/Nettify/Rss/Instance/RSSException.cs new file mode 100644 index 0000000..131780d --- /dev/null +++ b/Nettify/Rss/Instance/RSSException.cs @@ -0,0 +1,37 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using System; + +namespace Nettify.Rss.Instance +{ + internal class RSSException : Exception + { + public RSSException() + { } + + public RSSException(string message) + : base(message) + { } + + public RSSException(string message, Exception innerException) + : base(message, innerException) + { } + } +} diff --git a/Nettify/Rss/Instance/RSSFeed.cs b/Nettify/Rss/Instance/RSSFeed.cs new file mode 100644 index 0000000..874cd21 --- /dev/null +++ b/Nettify/Rss/Instance/RSSFeed.cs @@ -0,0 +1,189 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using System; +using System.Collections.Generic; +using System.Threading.Tasks; +using System.Xml; + +namespace Nettify.Rss.Instance +{ + /// + /// RSS feed class instance + /// + public class RSSFeed + { + + private string _FeedUrl; + private RSSFeedType _FeedType; + private string _FeedTitle; + private string _FeedDescription; + private List _FeedArticles = []; + + /// + /// A URL to RSS feed + /// + public string FeedUrl + => _FeedUrl; + + /// + /// RSS feed type + /// + public RSSFeedType FeedType + => _FeedType; + + /// + /// RSS feed type + /// + public string FeedTitle + => _FeedTitle; + + /// + /// RSS feed description (Atom feeds not supported and always return an empty string) + /// + public string FeedDescription + => _FeedDescription; + + /// + /// Feed articles + /// + public List FeedArticles + => _FeedArticles; + + /// + /// Makes a new instance of an RSS feed class + /// + /// A URL to RSS feed + /// A feed type to parse. If set to Infer, it will automatically detect the type based on contents. + public RSSFeed(string FeedUrl, RSSFeedType FeedType) + { + _FeedUrl = FeedUrl; + _FeedType = FeedType; + } + + /// + /// Refreshes the RSS class instance + /// + public void Refresh() + => Refresh(_FeedUrl, _FeedType); + + /// + /// Refreshes the RSS class instance + /// + /// A URL to RSS feed + /// A feed type to parse. If set to Infer, it will automatically detect the type based on contents. + public void Refresh(string FeedUrl, RSSFeedType FeedType) + { + // Make a web request indicator + var FeedWebRequest = RSSTools.Client.GetAsync(FeedUrl).Result; + + // Load the RSS feed and get the feed XML document + var FeedStream = FeedWebRequest.Content.ReadAsStreamAsync().Result; + var FeedDocument = new XmlDocument(); + FeedDocument.Load(FeedStream); + Finalize(FeedDocument, FeedType); + } + + /// + /// Refreshes the RSS class instance + /// + public async Task RefreshAsync() + => await RefreshAsync(_FeedUrl, _FeedType); + + /// + /// Refreshes the RSS class instance + /// + /// A URL to RSS feed + /// A feed type to parse. If set to Infer, it will automatically detect the type based on contents. + public async Task RefreshAsync(string FeedUrl, RSSFeedType FeedType) + { + // Make a web request indicator + var FeedWebRequest = await RSSTools.Client.GetAsync(FeedUrl); + + // Load the RSS feed and get the feed XML document + var FeedStream = await FeedWebRequest.Content.ReadAsStreamAsync(); + var FeedDocument = new XmlDocument(); + FeedDocument.Load(FeedStream); + Finalize(FeedDocument, FeedType); + } + + internal void Finalize(XmlDocument feedDocument, RSSFeedType feedType) + { + + // Infer feed type + var FeedNodeList = default(XmlNodeList); + if (feedType == RSSFeedType.Infer) + { + if (feedDocument.GetElementsByTagName("rss").Count != 0) + { + FeedNodeList = feedDocument.GetElementsByTagName("rss"); + _FeedType = RSSFeedType.RSS2; + } + else if (feedDocument.GetElementsByTagName("rdf:RDF").Count != 0) + { + FeedNodeList = feedDocument.GetElementsByTagName("rdf:RDF"); + _FeedType = RSSFeedType.RSS1; + } + else if (feedDocument.GetElementsByTagName("feed").Count != 0) + { + FeedNodeList = feedDocument.GetElementsByTagName("feed"); + _FeedType = RSSFeedType.Atom; + } + } + else if (feedType == RSSFeedType.RSS2) + { + FeedNodeList = feedDocument.GetElementsByTagName("rss"); + if (FeedNodeList.Count == 0) + throw new RSSException("Invalid RSS2 feed."); + } + else if (feedType == RSSFeedType.RSS1) + { + FeedNodeList = feedDocument.GetElementsByTagName("rdf:RDF"); + if (FeedNodeList.Count == 0) + throw new RSSException("Invalid RSS1 feed."); + } + else if (feedType == RSSFeedType.Atom) + { + FeedNodeList = feedDocument.GetElementsByTagName("feed"); + if (FeedNodeList.Count == 0) + throw new RSSException("Invalid Atom feed."); + } + + // Populate basic feed properties + string FeedTitle = Convert.ToString(RSSTools.GetFeedProperty("title", FeedNodeList, _FeedType)); + string FeedDescription = Convert.ToString(RSSTools.GetFeedProperty("description", FeedNodeList, _FeedType)); + + // Populate articles + var Articles = RSSTools.MakeRssArticlesFromFeed(FeedNodeList, _FeedType); + + // Install the variables to a new instance + _FeedUrl = FeedUrl; + _FeedTitle = FeedTitle.Trim(); + _FeedDescription = FeedDescription.Trim(); + if (_FeedArticles.Count != 0 & Articles.Count != 0) + { + if (!_FeedArticles[0].Equals(Articles[0])) + _FeedArticles = Articles; + } + else + _FeedArticles = Articles; + } + + } +} diff --git a/Nettify/Rss/Instance/RSSFeedType.cs b/Nettify/Rss/Instance/RSSFeedType.cs new file mode 100644 index 0000000..0d3596d --- /dev/null +++ b/Nettify/Rss/Instance/RSSFeedType.cs @@ -0,0 +1,44 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +namespace Nettify.Rss.Instance +{ + /// + /// Enumeration for RSS feed type + /// + public enum RSSFeedType + { + /// + /// The RSS format is RSS 2.0 + /// + RSS2, + /// + /// The RSS format is RSS 1.0 + /// + RSS1, + /// + /// The RSS format is Atom + /// + Atom, + /// + /// Try to infer RSS type + /// + Infer = 1024 + } +} diff --git a/Nettify/Rss/RSSTools.cs b/Nettify/Rss/RSSTools.cs new file mode 100644 index 0000000..360e067 --- /dev/null +++ b/Nettify/Rss/RSSTools.cs @@ -0,0 +1,182 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using HtmlAgilityPack; +using Nettify.Rss.Instance; +using System; +using System.Collections.Generic; +using System.Net.Http; +using System.Xml; + +namespace Nettify.Rss +{ + /// + /// The RSS tools + /// + public static class RSSTools + { + internal static HttpClient Client = new(); + + /// + /// Make instances of RSS Article from feed node and type + /// + /// Feed XML node + /// Feed type + public static List MakeRssArticlesFromFeed(XmlNodeList FeedNode, RSSFeedType FeedType) + { + var Articles = new List(); + switch (FeedType) + { + case RSSFeedType.RSS2: + foreach (XmlNode Node in FeedNode[0]) // + { + foreach (XmlNode Child in Node.ChildNodes) // + { + if (Child.Name == "item") + { + var Article = MakeArticleFromFeed(Child); + Articles.Add(Article); + } + } + } + + break; + case RSSFeedType.RSS1: + foreach (XmlNode Node in FeedNode[0]) // or + { + if (Node.Name == "item") + { + var Article = MakeArticleFromFeed(Node); + Articles.Add(Article); + } + } + + break; + case RSSFeedType.Atom: + foreach (XmlNode Node in FeedNode[0]) // + { + if (Node.Name == "entry") + { + var Article = MakeArticleFromFeed(Node); + Articles.Add(Article); + } + } + + break; + default: + throw new RSSException("Invalid RSS feed type."); + } + return Articles; + } + + /// + /// Generates an instance of article from feed + /// + /// The child node which holds the entire article + /// An article + public static RSSArticle MakeArticleFromFeed(XmlNode Article) + { + // Variables + var Parameters = new Dictionary(); + string Title = default, Link = default, Description = default; + + // Parse article + foreach (XmlNode ArticleNode in Article.ChildNodes) + { + // Check the title + if (ArticleNode.Name == "title") + // Trimming newlines and spaces is necessary, since some RSS feeds (GitHub commits) might return string with trailing and leading spaces and newlines. + Title = ArticleNode.InnerText.Trim(Convert.ToChar(Convert.ToChar(13)), Convert.ToChar(Convert.ToChar(10)), ' '); + + // Check the link + if (ArticleNode.Name == "link") + // Links can be in href attribute, so check that. + if (ArticleNode.Attributes.Count != 0 & ArticleNode.Attributes.GetNamedItem("href") is not null) + Link = ArticleNode.Attributes.GetNamedItem("href").InnerText; + else + Link = ArticleNode.InnerText; + + // Check the summary + if (ArticleNode.Name == "summary" | ArticleNode.Name == "content" | ArticleNode.Name == "description") + { + // It can be of HTML type, or plain text type. + if (ArticleNode.Attributes.Count != 0 & ArticleNode.Attributes.GetNamedItem("type") is not null) + { + if (ArticleNode.Attributes.GetNamedItem("type").Value == "html") + { + // Extract plain text from HTML + var HtmlContent = new HtmlDocument(); + HtmlContent.LoadHtml(ArticleNode.InnerText.Trim(Convert.ToChar(Convert.ToChar(13)), Convert.ToChar(Convert.ToChar(10)), ' ')); + + // Some feeds have no node called "pre," so work around this... + var PreNode = HtmlContent.DocumentNode.SelectSingleNode("pre"); + if (PreNode is null) + Description = HtmlContent.DocumentNode.InnerText; + else + Description = PreNode.InnerText; + } + else + Description = ArticleNode.InnerText.Trim(Convert.ToChar(Convert.ToChar(13)), Convert.ToChar(Convert.ToChar(10)), ' '); + } + else + Description = ArticleNode.InnerText.Trim(Convert.ToChar(Convert.ToChar(13)), Convert.ToChar(Convert.ToChar(10)), ' '); + } + if (!Parameters.ContainsKey(ArticleNode.Name)) + Parameters.Add(ArticleNode.Name, ArticleNode); + } + return new RSSArticle(Title, Link, Description, Parameters); + } + + /// + /// Gets a feed property + /// + /// Feed property name + /// Feed XML node + /// Feed type + public static object GetFeedProperty(string FeedProperty, XmlNodeList FeedNode, RSSFeedType FeedType) + { + switch (FeedType) + { + case RSSFeedType.RSS2: + foreach (XmlNode Node in FeedNode[0]) // + foreach (XmlNode Child in Node.ChildNodes) + if (Child.Name == FeedProperty) + return Child.InnerXml; + + break; + case RSSFeedType.RSS1: + foreach (XmlNode Node in FeedNode[0]) // or + foreach (XmlNode Child in Node.ChildNodes) + if (Child.Name == FeedProperty) + return Child.InnerXml; + + break; + case RSSFeedType.Atom: + foreach (XmlNode Node in FeedNode[0]) // Children of + if (Node.Name == FeedProperty) + return Node.InnerXml; + + break; + default: + throw new RSSException("Invalid RSS feed type."); + } + return ""; + } + } +} diff --git a/Nettify/Weather/Examples/Example01.json b/Nettify/Weather/Examples/Example01.json new file mode 100644 index 0000000..887280c --- /dev/null +++ b/Nettify/Weather/Examples/Example01.json @@ -0,0 +1,43 @@ +{ + "coord": { + "lon": -71.0598, + "lat": 42.3584 + }, + "weather": [ + { + "id": 701, + "main": "Mist", + "description": "mist", + "icon": "50n" + } + ], + "base": "stations", + "main": { + "temp": 11.46, + "feels_like": 11.01, + "temp_min": 9.61, + "temp_max": 12.45, + "pressure": 1027, + "humidity": 90 + }, + "visibility": 1609, + "wind": { + "speed": 3.09, + "deg": 350 + }, + "clouds": { + "all": 100 + }, + "dt": 1652334440, + "sys": { + "type": 2, + "id": 2013408, + "country": "US", + "sunrise": 1652347561, + "sunset": 1652399717 + }, + "timezone": -14400, + "id": 4930956, + "name": "Boston", + "cod": 200 +} diff --git a/Nettify/Weather/WeatherForecast.cs b/Nettify/Weather/WeatherForecast.cs new file mode 100644 index 0000000..1529a71 --- /dev/null +++ b/Nettify/Weather/WeatherForecast.cs @@ -0,0 +1,218 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +using System.Collections.Generic; +using System.Diagnostics; +using System.IO; +using System.IO.Compression; +using System.Net.Http; +using System.Text; +using System.Threading.Tasks; +using Newtonsoft.Json.Linq; + +namespace Nettify.Weather +{ + /// + /// The forecast tools + /// + public static class WeatherForecast + { + internal static HttpClient WeatherDownloader = new(); + + /// + /// Gets current weather info from OpenWeatherMap + /// + /// City ID + /// API key + /// The preferred unit to use + /// A class containing properties of weather information + public static WeatherForecastInfo GetWeatherInfo(long CityID, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) + { + string WeatherURL = $"http://api.openweathermap.org/data/2.5/weather?id={CityID}&appid={APIKey}"; + return GetWeatherInfo(WeatherURL, Unit); + } + + /// + /// Gets current weather info from OpenWeatherMap + /// + /// City name + /// API Key + /// The preferred unit to use + /// A class containing properties of weather information + public static WeatherForecastInfo GetWeatherInfo(string CityName, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) + { + string WeatherURL = $"http://api.openweathermap.org/data/2.5/weather?q={CityName}&appid={APIKey}"; + return GetWeatherInfo(WeatherURL, Unit); + } + + /// + /// Gets current weather info from OpenWeatherMap + /// + /// An URL to the weather API request + /// The preferred unit to use + /// A class containing properties of weather information + internal static WeatherForecastInfo GetWeatherInfo(string WeatherURL, UnitMeasurement Unit = UnitMeasurement.Metric) + { + string WeatherData; + JToken WeatherToken; + Debug.WriteLine("Weather URL: {0} | Unit: {1}", WeatherURL, Unit); + + // Deal with measurements + if (Unit == UnitMeasurement.Imperial) + WeatherURL += "&units=imperial"; + else + WeatherURL += "&units=metric"; + + // Download and parse JSON data + WeatherData = WeatherDownloader.GetStringAsync(WeatherURL).Result; + WeatherToken = JToken.Parse(WeatherData); + return FinalizeInstallation(WeatherToken, Unit); + } + + /// + /// Gets current weather info from OpenWeatherMap + /// + /// City ID + /// API key + /// The preferred unit to use + /// A class containing properties of weather information + public static async Task GetWeatherInfoAsync(long CityID, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) + { + string WeatherURL = $"http://api.openweathermap.org/data/2.5/weather?id={CityID}&appid={APIKey}"; + return await GetWeatherInfoAsync(WeatherURL, Unit); + } + + /// + /// Gets current weather info from OpenWeatherMap + /// + /// City name + /// API Key + /// The preferred unit to use + /// A class containing properties of weather information + public static async Task GetWeatherInfoAsync(string CityName, string APIKey, UnitMeasurement Unit = UnitMeasurement.Metric) + { + string WeatherURL = $"http://api.openweathermap.org/data/2.5/weather?q={CityName}&appid={APIKey}"; + return await GetWeatherInfoAsync(WeatherURL, Unit); + } + + /// + /// Gets current weather info from OpenWeatherMap + /// + /// An URL to the weather API request + /// The preferred unit to use + /// A class containing properties of weather information + internal static async Task GetWeatherInfoAsync(string WeatherURL, UnitMeasurement Unit = UnitMeasurement.Metric) + { + string WeatherData; + JToken WeatherToken; + Debug.WriteLine("Weather URL: {0} | Unit: {1}", WeatherURL, Unit); + + // Deal with measurements + if (Unit == UnitMeasurement.Imperial) + WeatherURL += "&units=imperial"; + else + WeatherURL += "&units=metric"; + + // Download and parse JSON data + WeatherData = await WeatherDownloader.GetStringAsync(WeatherURL); + WeatherToken = JToken.Parse(WeatherData); + return FinalizeInstallation(WeatherToken, Unit); + } + + internal static WeatherForecastInfo FinalizeInstallation(JToken WeatherToken, UnitMeasurement Unit = UnitMeasurement.Metric) + { + WeatherForecastInfo WeatherInfo = new() + { + // Put needed data to the class + Weather = (WeatherCondition)WeatherToken.SelectToken("weather").First.SelectToken("id").ToObject(typeof(WeatherCondition)), + Temperature = (double)WeatherToken.SelectToken("main").SelectToken("temp").ToObject(typeof(double)), + FeelsLike = (double)WeatherToken.SelectToken("main").SelectToken("feels_like").ToObject(typeof(double)), + Pressure = (double)WeatherToken.SelectToken("main").SelectToken("pressure").ToObject(typeof(double)), + Humidity = (double)WeatherToken.SelectToken("main").SelectToken("humidity").ToObject(typeof(double)), + WindSpeed = (double)WeatherToken.SelectToken("wind").SelectToken("speed").ToObject(typeof(double)), + WindDirection = (double)WeatherToken.SelectToken("wind").SelectToken("deg").ToObject(typeof(double)), + CityID = (long)WeatherToken.SelectToken("id").ToObject(typeof(long)), + CityName = (string)WeatherToken.SelectToken("name").ToObject(typeof(string)), + TemperatureMeasurement = Unit + }; + return WeatherInfo; + } + + /// + /// Lists all the available cities + /// + public static Dictionary ListAllCities() + { + string WeatherCityListURL = $"http://bulk.openweathermap.org/sample/city.list.json.gz"; + Stream WeatherCityListDataStream; + Debug.WriteLine("Weather City List URL: {0}", WeatherCityListURL); + + // Open the stream to the city list URL + WeatherCityListDataStream = WeatherDownloader.GetStreamAsync(WeatherCityListURL).Result; + return FinalizeCityList(WeatherCityListDataStream); + } + + /// + /// Lists all the available cities + /// + public static async Task> ListAllCitiesAsync() + { + string WeatherCityListURL = $"http://bulk.openweathermap.org/sample/city.list.json.gz"; + Stream WeatherCityListDataStream; + Debug.WriteLine("Weather City List URL: {0}", WeatherCityListURL); + + // Open the stream to the city list URL + WeatherCityListDataStream = await WeatherDownloader.GetStreamAsync(WeatherCityListURL); + return FinalizeCityList(WeatherCityListDataStream); + } + + internal static Dictionary FinalizeCityList(Stream WeatherCityListDataStream) + { + GZipStream WeatherCityListData; + var WeatherCityListUncompressed = new List(); + int WeatherCityListReadByte = 0; + JToken WeatherCityListToken; + var WeatherCityList = new Dictionary(); + + // Parse the weather list JSON. Since the output is gzipped, we'll have to uncompress it using stream, since the city list + // is large anyways. This saves you from downloading full 45+ MB of text. + WeatherCityListData = new GZipStream(WeatherCityListDataStream, CompressionMode.Decompress, false); + while (WeatherCityListReadByte != -1) + { + WeatherCityListReadByte = WeatherCityListData.ReadByte(); + if (WeatherCityListReadByte != -1) + WeatherCityListUncompressed.Add((byte)WeatherCityListReadByte); + } + + WeatherCityListToken = JToken.Parse(Encoding.Default.GetString([.. WeatherCityListUncompressed])); + + // Put needed data to the class + foreach (JToken WeatherCityToken in WeatherCityListToken) + { + long cityId = (long)WeatherCityToken["id"]; + string cityName = (string)WeatherCityToken["name"]; + if (!WeatherCityList.ContainsKey(cityId)) + WeatherCityList.Add(cityId, cityName); + } + + // Return list + return WeatherCityList; + } + } +} diff --git a/Nettify/Weather/WeatherForecastInfo.cs b/Nettify/Weather/WeatherForecastInfo.cs new file mode 100644 index 0000000..22a5e76 --- /dev/null +++ b/Nettify/Weather/WeatherForecastInfo.cs @@ -0,0 +1,325 @@ +// +// Nettify Copyright (C) 2023-2024 Aptivi +// +// This file is part of Nettify +// +// Nettify is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Nettify is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY, without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// + +namespace Nettify.Weather +{ + /// + /// Forecast information + /// + public partial class WeatherForecastInfo + { + /// + /// City ID + /// + public long CityID { get; set; } + /// + /// City Name + /// + public string CityName { get; set; } + /// + /// Weather condition + /// + public WeatherCondition Weather { get; set; } + /// + /// Temperature measurement + /// + public UnitMeasurement TemperatureMeasurement { get; set; } + /// + /// Temperature + /// + public double Temperature { get; set; } + /// + /// Feels like + /// + public double FeelsLike { get; set; } + /// + /// Pressure in hPa + /// + public double Pressure { get; set; } + /// + /// Humidity in percent + /// + public double Humidity { get; set; } + /// + /// Wind speed. Imperial: mph, Metric/Kelvin: m.s + /// + public double WindSpeed { get; set; } + /// + /// Wind direction in degrees + /// + public double WindDirection { get; set; } + } + + /// + /// Unit measurement + /// + public enum UnitMeasurement + { + /// + /// Default unit measurement for OWM + /// + Kelvin = 1, + /// + /// Metric units (Celsius) + /// + Metric, + /// + /// Imperial units (Fahrenheit) + /// + Imperial + } + + /// + /// Weather condition + /// + public enum WeatherCondition + { + // Thunderstorms + /// + /// Thunderstorm with light rain + /// + ThunderstormLightRain = 200, + /// + /// Thunderstorm with rain + /// + ThunderstormRain, + /// + /// Thunderstorm with heavy rain + /// + ThunderstormHeavyRain, + /// + /// Light thunderstorm + /// + LightThunderstorm = 210, + /// + /// Thunderstorm + /// + Thunderstorm, + /// + /// Heavy thunderstorm + /// + HeavyThunderstorm, + /// + /// Ragged thunderstorm + /// + RaggedThunderstorm = 221, + /// + /// Thunderstorm with light drizzle + /// + ThunderstormLightDrizzle = 230, + /// + /// Thunderstorm with drizzle + /// + ThunderstormDrizzle = 231, + /// + /// Thunderstorm with heavy drizzle + /// + ThunderstormHeavyDrizzle = 232, + + // Drizzles + /// + /// Light intensity drizzle + /// + LightDrizzle = 300, + /// + /// Drizzle + /// + Drizzle, + /// + /// Heavy intensity drizzle + /// + HeavyDrizzle, + /// + /// Light intensity drizzle rain + /// + LightDrizzleRain = 310, + /// + /// Drizzle rain + /// + DrizzleRain, + /// + /// Heavy intensity drizzle rain + /// + HeavyDrizzleRain, + /// + /// Shower rain and drizzle + /// + DrizzleShowerRain, + /// + /// Heavy shower rain and drizzle + /// + DrizzleHeavyShowerRain, + /// + /// Shower drizzle + /// + ShowerDrizzle = 321, + + // Rains + /// + /// Light rain + /// + LightRain = 500, + /// + /// Moderate rain + /// + ModerateRain, + /// + /// Heavy rain + /// + HeavyRain, + /// + /// Very heavy rain + /// + VeryHeavyRain, + /// + /// Extreme rain + /// + ExtremeRain, + /// + /// Freezing rain + /// + FreezingRain = 511, + /// + /// Light shower rain + /// + LightShowerRain = 520, + /// + /// Shower rain + /// + ShowerRain, + /// + /// Heavy shower rain + /// + HeavyShowerRain, + /// + /// Ragged shower rain + /// + RaggedShowerRain = 531, + + // Snows + /// + /// Light snow + /// + LightSnow = 600, + /// + /// Snow + /// + Snow, + /// + /// Heavy snow + /// + HeavySnow, + /// + /// Sleet + /// + Sleet = 611, + /// + /// Light shower sleet + /// + LightShowerSleet, + /// + /// Shower sleet + /// + ShowerSleet, + /// + /// Light rain and snow + /// + LightRainAndSnow = 615, + /// + /// Rain and snow + /// + RainAndSnow, + /// + /// Light shower snow + /// + LightShowerSnow = 620, + /// + /// Shower snow + /// + ShowerSnow, + /// + /// Heavy shower snow + /// + HeavyShowerSnow, + + // Atmosphere + /// + /// Misty weather + /// + Mist = 701, + /// + /// Smoky weather + /// + Smoke = 711, + /// + /// Hazy weather + /// + Haze = 721, + /// + /// Sand or dust whirls + /// + DustWhirls = 731, + /// + /// Foggy weather + /// + Fog = 741, + /// + /// Sandy weather + /// + Sand = 751, + /// + /// Dusty weather + /// + Dust = 761, + /// + /// Volcanic ash + /// + Ash, + /// + /// Squall + /// + Squall = 771, + /// + /// Tornado + /// + Tornado = 781, + + // Clear and Clouds + /// + /// Clear sky (free of clouds) + /// + Clear = 800, + /// + /// Few clouds (11-25%) + /// + FewClouds, + /// + /// Partly cloudy (Scattered, 25-50%) + /// + PartlyCloudy, + /// + /// Broken Clouds (51-84%) + /// + BrokenClouds, + /// + /// Mostly Cloudy (Overcast, 85-100%) + /// + MostlyCloudy + } +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..b47cc2c --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ + +
+ +
+
+ + + +
+ +# Nettify + +*Network accessory tools for C#.* + +
+
+ +[![Badge Main]][Main]    +[![Badge Main Linux]][Main Linux] + +[![Badge Latest]][Latest]    +[![Badge NuGet]][NuGet] + +![Badge Size]    +[![Badge Downloads]][Releases] + +[![Button Manual]][Manual]    +[![Button Libraries]][Libraries] + +
+ +
+ + + + + + +[Releases]: https://github.com/Aptivi/Nettify/releases +[Latest]: https://github.com/Aptivi/Nettify/releases/latest +[NuGet]: https://www.nuget.org/packages/Nettify.Offline/ + +[Main]: https://github.com/Aptivi/Nettify/actions/workflows/build-win.yml +[Main Linux]: https://github.com/Aptivi/Nettify/actions/workflows/build-linux.yml + +[Libraries]: https://aptivi.gitbook.io/nettify-manual/project-dependencies +[Manual]: https://aptivi.gitbook.io/nettify-manual/ + + + +[Badge Downloads]: https://img.shields.io/github/downloads/Aptivi/Nettify/total?color=217346&label=Downloads&style=for-the-badge&logoColor=white&logo=DocuSign&labelColor=2d9d5f +[Badge Latest]: https://img.shields.io/github/v/release/Aptivi/Nettify?color=212121&include_prereleases&label=github&style=for-the-badge&logoColor=white&logo=AzureArtifacts&labelColor=303030 +[Badge NuGet]: https://img.shields.io/nuget/vpre/Nettify.Offline?color=012f52&style=for-the-badge&logoColor=white&logo=NuGet&labelColor=004880 +[Badge Size]: https://img.shields.io/github/repo-size/Aptivi/Nettify?color=bb4a28&label=size&logoColor=white&style=for-the-badge&logo=GoogleAnalytics&labelColor=E85C33 + +[Badge Main]: https://github.com/Aptivi/Nettify/actions/workflows/build-win.yml/badge.svg +[Badge Main Linux]: https://github.com/Aptivi/Nettify/actions/workflows/build-linux.yml/badge.svg + + + + +[Button Libraries]: https://img.shields.io/badge/Libraries-EA8220?style=for-the-badge&logoColor=white&logo=AzureArtifacts +[Button Manual]: https://img.shields.io/badge/Docs-blueviolet?style=for-the-badge&logoColor=white&logo=GitBook diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..51a4eca --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,19 @@ +## Reporting security problems + +Thanks for finding security problems in our project! To report them, you must look at the supported versions in our GitBook page, which can be usually accessed by going to the project's main page at GitHub and selecting `Docs`. + +In case of the libraries, only the latest versions are supported. + +### How to report? + +Good question! To report security bugs, report them in the Issues section of our project. + +1. Go to our project's GitHub page +2. Click on Issues +3. Click on `New Issue` +4. Click on `Get Started` next to `Report an issue` +5. Fill in relevant details about this security bug +6. Click on the cogwheel icon next to `Labels` and click on `SECURITY` +7. Click on `Submit new issue` + +If we can reproduce your security issue, the security advisory will be published days after review. diff --git a/aptivi_snk.snk b/aptivi_snk.snk new file mode 100644 index 0000000..b87cfc8 Binary files /dev/null and b/aptivi_snk.snk differ diff --git a/tools/Makefile b/tools/Makefile new file mode 100644 index 0000000..77bbf99 --- /dev/null +++ b/tools/Makefile @@ -0,0 +1,9 @@ +# Below is a workaround for .NET SDK 7.0 trying to allocate large amounts of memory for GC work: +# https://github.com/dotnet/runtime/issues/85556#issuecomment-1529177092 +DOTNET_PAGE_SIZE = $(shell getconf PAGESIZE) +DOTNET_AVPHYS_PAGES = $(shell getconf _AVPHYS_PAGES) +DOTNET_HEAP_LIMIT = $(shell printf '%X\n' $$(($(DOTNET_AVPHYS_PAGES) * $(DOTNET_PAGE_SIZE)))) + +invoke-build: + chmod +x ./build.sh + ./build.sh || (echo Retrying with heap limit 0x$(DOTNET_HEAP_LIMIT)... && DOTNET_GCHeapHardLimit=$(DOTNET_HEAP_LIMIT) ./build.sh) diff --git a/tools/build.cmd b/tools/build.cmd new file mode 100644 index 0000000..1f306ad --- /dev/null +++ b/tools/build.cmd @@ -0,0 +1,23 @@ +@echo off + +REM This script builds and packs the artifacts. Use when you have VS installed. +set releaseconfig=%1 +if "%releaseconfig%" == "" set releaseconfig=Release + +:download +echo Downloading packages... +"%ProgramFiles%\dotnet\dotnet.exe" msbuild "..\Nettify.sln" -t:restore -p:Configuration=%releaseconfig% +if %errorlevel% == 0 goto :build +echo There was an error trying to download packages (%errorlevel%). +goto :finished + +:build +echo Building Nitrocid KS... +"%ProgramFiles%\dotnet\dotnet.exe" msbuild "..\Nettify.sln" -p:Configuration=%releaseconfig% +if %errorlevel% == 0 goto :success +echo There was an error trying to build (%errorlevel%). +goto :finished + +:success +echo Build successful. +:finished diff --git a/tools/build.sh b/tools/build.sh new file mode 100644 index 0000000..592d8d1 --- /dev/null +++ b/tools/build.sh @@ -0,0 +1,34 @@ +#!/bin/bash + +# This script builds. Use when you have dotnet installed. +releaseconf=$1 +if [ -z $releaseconf ]; then + releaseconf=Release +fi + +# Check for dependencies +dotnetpath=`which dotnet` +if [ ! $? == 0 ]; then + echo dotnet is not found. + exit 1 +fi + +# Download packages +echo Downloading packages... +"$dotnetpath" msbuild "../Nettify.sln" -t:restore -p:Configuration=$releaseconf +if [ ! $? == 0 ]; then + echo Download failed. + exit 1 +fi + +# Build KS +echo Building KS... +"$dotnetpath" msbuild "../Nettify.sln" -p:Configuration=$releaseconf +if [ ! $? == 0 ]; then + echo Build failed. + exit 1 +fi + +# Inform success +echo Build successful. +exit 0 diff --git a/tools/docgen-pack.cmd b/tools/docgen-pack.cmd new file mode 100644 index 0000000..3309565 --- /dev/null +++ b/tools/docgen-pack.cmd @@ -0,0 +1,22 @@ +@echo off + +REM This script builds KS documentation and packs the artifacts. Use when you have VS installed. +for /f "tokens=* USEBACKQ" %%f in (`type version`) do set ksversion=%%f + +:pack +echo Packing documentation... +"%ProgramFiles%\7-Zip\7z.exe" a -tzip %temp%/%ksversion%-doc.zip "..\docs\*" +if %errorlevel% == 0 goto :finalize +echo There was an error trying to pack documentation (%errorlevel%). +goto :finished + +:finalize +rmdir /S /Q "..\DocGen\api\" +rmdir /S /Q "..\DocGen\obj\" +rmdir /S /Q "..\docs\" +move %temp%\%ksversion%-doc.zip +echo Build and pack successful. +goto :finished + +:finished +pause diff --git a/tools/docgen-pack.sh b/tools/docgen-pack.sh new file mode 100644 index 0000000..7ac1782 --- /dev/null +++ b/tools/docgen-pack.sh @@ -0,0 +1,27 @@ +#!/bin/bash + +# This script builds KS and packs the artifacts. Use when you have MSBuild installed. +ksversion=$(cat version) + +# Check for dependencies +zippath=`which zip` +if [ ! $? == 0 ]; then + echo zip is not found. + exit 1 +fi + +# Pack documentation +echo Packing documentation... +cd "../docs/" && "$zippath" -r /tmp/$ksversion-doc.zip . && cd - +if [ ! $? == 0 ]; then + echo Packing failed. + exit 1 +fi + +# Inform success +rm -rf "../DocGen/api" +rm -rf "../DocGen/obj" +rm -rf "../docs" +mv /tmp/$ksversion-doc.zip . +echo Pack successful. +exit 0 diff --git a/tools/docgen.cmd b/tools/docgen.cmd new file mode 100644 index 0000000..e408d76 --- /dev/null +++ b/tools/docgen.cmd @@ -0,0 +1,19 @@ +@echo off + +REM This script builds documentation and packs the artifacts. + +echo Finding DocFX... +if exist %ProgramData%\chocolatey\bin\docfx.exe goto :build +echo You don't have DocFX installed. Download and install Chocolatey and DocFX. +goto :finished + +:build +echo Building Documentation... +%ProgramData%\chocolatey\bin\docfx.exe "..\DocGen\docfx.json" +if %errorlevel% == 0 goto :success +echo There was an error trying to build documentation (%errorlevel%). +goto :finished + +:success +echo Build and pack successful. +:finished diff --git a/tools/docgen.sh b/tools/docgen.sh new file mode 100644 index 0000000..b22aafd --- /dev/null +++ b/tools/docgen.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +# Check for dependencies +msbuildpath=`which docfx` +if [ ! $? == 0 ]; then + echo DocFX is not found. + exit 1 +fi + +# Build KS +echo Building documentation... +docfx DocGen/docfx.json +if [ ! $? == 0 ]; then + echo Build failed. + exit 1 +fi + +# Inform success +echo Build successful. +exit 0 diff --git a/tools/pack.cmd b/tools/pack.cmd new file mode 100644 index 0000000..b4ef6ec --- /dev/null +++ b/tools/pack.cmd @@ -0,0 +1,18 @@ +@echo off + +for /f "tokens=* USEBACKQ" %%f in (`type version`) do set version=%%f +set releaseconfig=%1 +if "%releaseconfig%" == "" set releaseconfig=Release + +:packbin +echo Packing binary... +"%ProgramFiles%\7-Zip\7z.exe" a -tzip %temp%/%version%-bin.zip "..\Nettify\bin\%releaseconfig%\netstandard2.0\*" +if %errorlevel% == 0 goto :complete +echo There was an error trying to pack binary (%errorlevel%). +goto :finished + +:complete +move %temp%\%version%-bin.zip + +echo Pack successful. +:finished diff --git a/tools/pack.sh b/tools/pack.sh new file mode 100644 index 0000000..999167c --- /dev/null +++ b/tools/pack.sh @@ -0,0 +1,28 @@ +#!/bin/bash + +# This script builds and packs the artifacts. Use when you have MSBuild installed. +version=$(cat version) +releaseconf=$1 +if [ -z $releaseconf ]; then + releaseconf=Release +fi + +# Check for dependencies +zippath=`which zip` +if [ ! $? == 0 ]; then + echo zip is not found. + exit 1 +fi + +# Pack binary +echo Packing binary... +cd "../Nettify/bin/$releaseconf/netstandard2.0/" && "$zippath" -r /tmp/$version-bin.zip . && cd - +if [ ! $? == 0 ]; then + echo Packing using zip failed. + exit 1 +fi + +# Inform success +mv ~/tmp/$version-bin.zip . +echo Build and pack successful. +exit 0 diff --git a/tools/version b/tools/version new file mode 100644 index 0000000..3eefcb9 --- /dev/null +++ b/tools/version @@ -0,0 +1 @@ +1.0.0