├── .npmrc ├── .eslintignore ├── versions.json ├── .editorconfig ├── manifest.json ├── .gitignore ├── styles.css ├── tsconfig.json ├── Snippet-downloader ├── utils.ts ├── modals │ ├── simpleCommands.ts │ ├── excludeSnippet.ts │ └── updateSnippets.ts ├── removeSnippet.ts ├── addSnippets.ts ├── downloader.ts ├── main.ts └── settings.ts ├── version-bump.mjs ├── .eslintrc ├── .github ├── ISSUE_TEMPLATE │ ├── feature_request.md │ ├── bug-report-template.md │ └── bug-script-report.md └── workflows │ ├── release.yml │ └── npm_release.yml ├── package.json ├── esbuild.config.mjs ├── README.md ├── CHANGELOG.md └── LICENSE /.npmrc: -------------------------------------------------------------------------------- 1 | tag-version-prefix="" -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | npm node_modules 2 | build -------------------------------------------------------------------------------- /versions.json: -------------------------------------------------------------------------------- 1 | { 2 | "1.0.0": "0.9.7", 3 | "1.0.1": "0.12.0" 4 | } 5 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # top-most EditorConfig file 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | insert_final_newline = true 7 | indent_style = tab 8 | indent_size = 4 9 | tab_width = 4 10 | -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "obsidian-snippet-downloader", 3 | "name": "Snippet Downloader", 4 | "version": "2.0.1", 5 | "minAppVersion": "0.12.0", 6 | "description": "A obsidian's plugin to help to manage css snippets (download / update) from repository ", 7 | "author": "Mara-Li", 8 | "authorUrl": "www.mara-li.fr", 9 | "isDesktopOnly": false 10 | } 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # vscode 2 | .vscode 3 | 4 | # Intellij 5 | *.iml 6 | .idea 7 | 8 | # npm 9 | node_modules 10 | 11 | # Don't include the compiled main.js file in the repo. 12 | # They should be uploaded to GitHub releases instead. 13 | main.js 14 | 15 | # Exclude sourcemaps 16 | *.map 17 | 18 | # obsidian 19 | data.json 20 | 21 | # Exclude macOS Finder (System Explorer) View States 22 | .DS_Store 23 | -------------------------------------------------------------------------------- /styles.css: -------------------------------------------------------------------------------- 1 | .setting-item.snippets-downloader-settings { 2 | border: none; 3 | padding: 0.5em 1em; 4 | } 5 | summary.snippets-downloader-summary { 6 | height: 2em; 7 | margin-bottom: 1em; 8 | } 9 | .setting-item.snippets-downloader-options { 10 | top:-2em; 11 | position: relative; 12 | } 13 | 14 | button.snippets-downloader-button { 15 | background: transparent !important; 16 | border: none !important; 17 | box-shadow: none !important; 18 | } 19 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": ".", 4 | "inlineSourceMap": true, 5 | "inlineSources": true, 6 | "module": "ESNext", 7 | "target": "ES6", 8 | "allowJs": true, 9 | "noImplicitAny": true, 10 | "moduleResolution": "node", 11 | "importHelpers": true, 12 | "isolatedModules": true, 13 | "lib": [ 14 | "DOM", 15 | "ES5", 16 | "ES6", 17 | "ES7" 18 | ] 19 | }, 20 | "include": [ 21 | "**/*.ts" 22 | ] 23 | } 24 | -------------------------------------------------------------------------------- /Snippet-downloader/utils.ts: -------------------------------------------------------------------------------- 1 | export function searchExcluded(excludedSnippet: string, name: string): boolean { 2 | if (excludedSnippet.length < 1) { 3 | return false; 4 | } 5 | const excluded = excludedSnippet.split(",").map(e => {return e.trim();}).filter(x=>x.length>0) 6 | for (const excl of excluded){ 7 | if (excl === name.replace('.css', '').trim()){ 8 | return true; 9 | } 10 | if (name.match(new RegExp(excl))){ 11 | return true; 12 | } 13 | } 14 | return false; 15 | } 16 | 17 | export function basename(path: string) { 18 | return path.split('/').reverse()[0]; 19 | } 20 | -------------------------------------------------------------------------------- /version-bump.mjs: -------------------------------------------------------------------------------- 1 | import { readFileSync, writeFileSync } from "fs"; 2 | 3 | const targetVersion = process.env.npm_package_version; 4 | 5 | // read minAppVersion from manifest.json and bump version to target version 6 | let manifest = JSON.parse(readFileSync("manifest.json", "utf8")); 7 | const { minAppVersion } = manifest; 8 | manifest.version = targetVersion; 9 | writeFileSync("manifest.json", JSON.stringify(manifest, null, "\t")); 10 | 11 | // update versions.json with target version and minAppVersion from manifest.json 12 | let versions = JSON.parse(readFileSync("versions.json", "utf8")); 13 | versions[targetVersion] = minAppVersion; 14 | writeFileSync("versions.json", JSON.stringify(versions, null, "\t")); 15 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "parser": "@typescript-eslint/parser", 4 | "env": { "node": true }, 5 | "plugins": [ 6 | "@typescript-eslint" 7 | ], 8 | "extends": [ 9 | "eslint:recommended", 10 | "plugin:@typescript-eslint/eslint-recommended", 11 | "plugin:@typescript-eslint/recommended" 12 | ], 13 | "parserOptions": { 14 | "sourceType": "module" 15 | }, 16 | "rules": { 17 | "no-unused-vars": "off", 18 | "@typescript-eslint/no-unused-vars": ["error", { "args": "none" }], 19 | "@typescript-eslint/ban-ts-comment": "off", 20 | "no-prototype-builtins": "off", 21 | "@typescript-eslint/no-empty-function": "off" 22 | } 23 | } -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: "[FR]" 5 | labels: enhancement 6 | assignees: Mara-Li 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | 12 | 13 | **Describe the solution you'd like** 14 | 15 | 16 | **Describe alternatives you've considered** 17 | 18 | 19 | **Additional context** 20 | 21 | -------------------------------------------------------------------------------- /Snippet-downloader/modals/simpleCommands.ts: -------------------------------------------------------------------------------- 1 | import { App, Modal, Setting } from "obsidian"; 2 | export class SnippetDownloaderModals extends Modal { 3 | result: string; 4 | onSubmit: (result: string) => void; 5 | 6 | constructor(app: App, onSubmit: (result: string) => void) { 7 | super(app); 8 | this.onSubmit = onSubmit; 9 | } 10 | 11 | onOpen() { 12 | const {contentEl} = this; 13 | contentEl.createEl("h1", { text: "Repo Links" }); 14 | new Setting(contentEl) 15 | .setName("Repo Link") 16 | .addText((text) => { 17 | text.onChange((value) => { 18 | this.result = value; 19 | }); 20 | }) 21 | new Setting(contentEl) 22 | .addButton((btn) =>{ 23 | btn 24 | .setButtonText("Submit") 25 | .setCta() 26 | .onClick(() => { 27 | this.close() 28 | this.onSubmit(this.result); 29 | }); 30 | }) 31 | } 32 | 33 | onClose() { 34 | const {contentEl} = this; 35 | contentEl.empty(); 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "obsidian-snippet-downloader", 3 | "version": "2.0.1", 4 | "description": "A obsidian's plugin to help to manage css snippets (download / update) from repository ", 5 | "main": "main.js", 6 | "scripts": { 7 | "dev": "node esbuild.config.mjs", 8 | "build": "node esbuild.config.mjs production", 9 | "version": "node version-bump.mjs && git add manifest.json versions.json", 10 | "release": "standard-version" 11 | }, 12 | "standard-version": { 13 | "t": "", 14 | "header": "# Changelog" 15 | }, 16 | "keywords": [], 17 | "author": "Mara-Li", 18 | "license": "AGPL-3.0", 19 | "devDependencies": { 20 | "@types/node": "^16.11.6", 21 | "@typescript-eslint/eslint-plugin": "^5.2.0", 22 | "@typescript-eslint/parser": "^5.2.0", 23 | "builtin-modules": "^3.2.0", 24 | "esbuild": "0.13.12", 25 | "eslint": "^8.13.0", 26 | "obsidian": "latest", 27 | "tslib": "2.3.1", 28 | "typescript": "4.4.4" 29 | }, 30 | "dependencies": { 31 | "@octokit/core": "^3.6.0", 32 | "js-base64": "^3.7.2", 33 | "standard-version": "^9.3.2" 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug-report-template.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report template 3 | about: Report a bug on the mkdocs template 4 | title: "[BUG]" 5 | labels: bug, Template 6 | assignees: Mara-Li 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | 12 | 13 | **To Reproduce** 14 | 19 | 20 | **Log** 21 | 22 | 23 | **Screenshots** 24 | 25 | 26 | **Desktop :** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone :** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | 39 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug-script-report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug script report 3 | about: Report a bug for the python script Obs2mk 4 | title: "[BUG]" 5 | labels: bug, script 6 | assignees: Mara-Li 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | 12 | 13 | **To Reproduce** 14 | 19 | 20 | **Log** 21 | 22 | 23 | **Screenshots** 24 | 25 | 26 | **Desktop :** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone :** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | 39 | -------------------------------------------------------------------------------- /esbuild.config.mjs: -------------------------------------------------------------------------------- 1 | import esbuild from "esbuild"; 2 | import process from "process"; 3 | import builtins from 'builtin-modules' 4 | 5 | const banner = 6 | `/* 7 | THIS IS A GENERATED/BUNDLED FILE BY ESBUILD 8 | if you want to view the source, please visit the github repository of this plugin 9 | */ 10 | `; 11 | 12 | const prod = (process.argv[2] === 'production'); 13 | 14 | esbuild.build({ 15 | banner: { 16 | js: banner, 17 | }, 18 | entryPoints: ['Snippet-downloader/main.ts'], 19 | bundle: true, 20 | external: [ 21 | 'obsidian', 22 | 'electron', 23 | '@codemirror/autocomplete', 24 | '@codemirror/closebrackets', 25 | '@codemirror/collab', 26 | '@codemirror/commands', 27 | '@codemirror/comment', 28 | '@codemirror/fold', 29 | '@codemirror/gutter', 30 | '@codemirror/highlight', 31 | '@codemirror/history', 32 | '@codemirror/language', 33 | '@codemirror/lint', 34 | '@codemirror/matchbrackets', 35 | '@codemirror/panel', 36 | '@codemirror/rangeset', 37 | '@codemirror/rectangular-selection', 38 | '@codemirror/search', 39 | '@codemirror/state', 40 | '@codemirror/stream-parser', 41 | '@codemirror/text', 42 | '@codemirror/tooltip', 43 | '@codemirror/view', 44 | ...builtins], 45 | format: 'cjs', 46 | watch: !prod, 47 | target: 'es2016', 48 | logLevel: "info", 49 | sourcemap: prod ? false : 'inline', 50 | treeShaking: true, 51 | outfile: 'main.js', 52 | }).catch(() => process.exit(1)); 53 | -------------------------------------------------------------------------------- /Snippet-downloader/removeSnippet.ts: -------------------------------------------------------------------------------- 1 | import {SnippetRepo} from "./settings"; 2 | import {Notice} from "obsidian"; 3 | import {searchExcluded} from "./utils"; 4 | 5 | function removeErrorSnippet(repoPath: string, errorSnippet: string, snippetList: SnippetRepo[]){ 6 | const snippet = snippetList.find(snippet => snippet.repo === repoPath) 7 | let errorSnippetList = errorSnippet.split(', '); 8 | for (const snippetContents of snippet.snippetsContents) { 9 | errorSnippetList=errorSnippetList.filter(v=>v!=snippetContents.name.replace('.css', '').trim()); 10 | } 11 | console.log(errorSnippetList) 12 | return errorSnippetList.join(', '); 13 | } 14 | 15 | export function removeSnippet(repoPath: string, snippetList: SnippetRepo[], errorSnippet: string) { 16 | if (snippetList.some(snippet => snippet.repo === repoPath)) { 17 | errorSnippet = removeErrorSnippet(repoPath, errorSnippet, snippetList) 18 | snippetList.splice(snippetList.findIndex(snippet => snippet.repo === repoPath), 1) 19 | new Notice('Repository successfully removed 🎉'); 20 | return [snippetList, errorSnippet] 21 | } 22 | new Notice ('Error : this repo is not in the list 😿'); 23 | return [snippetList, errorSnippet] 24 | } 25 | 26 | export function removeSnippetFromExcluded(repoPath: string, snippetList: SnippetRepo[], errorSnippet: string, excludedSnippet: string) { 27 | const repo = snippetList.find(snippet => snippet.repo === repoPath) 28 | repo.snippetsContents=repo.snippetsContents.filter(snippet=>!searchExcluded(excludedSnippet, snippet.name) && !(searchExcluded(errorSnippet, snippet.name))) 29 | return snippetList 30 | } 31 | -------------------------------------------------------------------------------- /Snippet-downloader/modals/excludeSnippet.ts: -------------------------------------------------------------------------------- 1 | import {App, FuzzySuggestModal, Notice} from "obsidian"; 2 | import {SnippetDownloaderSettings} from "../settings"; 3 | import snippetDownloader from "../main"; 4 | import {basename, searchExcluded} from "../utils"; 5 | import {removeSnippetFromExcluded} from "../removeSnippet"; 6 | 7 | export interface SnippetExclude { 8 | repo: string; 9 | snippetPath: string; 10 | } 11 | 12 | export function getExcludedSnippets(settings: SnippetDownloaderSettings) { 13 | const allSnippet: SnippetExclude[] = []; 14 | for (const snippet of settings.snippetList) { 15 | for (const snippetContent of snippet.snippetsContents) { 16 | if (snippetContent.name !== 'obsidian.css' && !searchExcluded(settings.excludedSnippet, snippetContent.name) && !searchExcluded(settings.errorSnippet, snippetContent.name)) { 17 | allSnippet.push({ 18 | repo: snippet.repo, 19 | snippetPath: snippetContent.name, 20 | }); 21 | } 22 | } 23 | } 24 | return allSnippet 25 | } 26 | 27 | export async function addExcludedSnippet(item: SnippetExclude, settings: SnippetDownloaderSettings){ 28 | let excludedSnippet = settings.excludedSnippet; 29 | excludedSnippet = excludedSnippet + ', ' + item.snippetPath; 30 | const snippetList = removeSnippetFromExcluded(item.repo, settings.snippetList, settings.errorSnippet, excludedSnippet); 31 | return [snippetList, excludedSnippet]; 32 | } 33 | 34 | export class ExcludeSnippet extends FuzzySuggestModal { 35 | app: App; 36 | settings: SnippetDownloaderSettings; 37 | plugin: snippetDownloader; 38 | 39 | constructor(app: App, settings: SnippetDownloaderSettings, plugin:snippetDownloader){ 40 | super(app); 41 | this.settings = settings; 42 | this.plugin = plugin; 43 | } 44 | 45 | getItemText(item: SnippetExclude): string { 46 | return basename(item.snippetPath); 47 | } 48 | 49 | getItems(): SnippetExclude[] { 50 | return getExcludedSnippets(this.settings) 51 | } 52 | 53 | async onChooseItem(item: SnippetExclude, evt: MouseEvent | KeyboardEvent) { 54 | const newSettings=await addExcludedSnippet(item, this.settings); 55 | await this.plugin.updateList(newSettings); 56 | new Notice(`${basename(item.snippetPath)} has been excluded! 🎉`) 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Obsidian Snippet Downloader 2 | 3 | This plugin is here to help you to download and update css snippet that are on a GitHub repository. 4 | 5 | The plugin will download all css snippet on a repository, unless : 6 | - There are two big (< 1MB) 7 | - There are named `obsidian.css` (use BRAT for themes) 8 | - There are excluded (see settings & excluded) 9 | 10 | In setting, you can : 11 | - Delete a repository. Warning ! It will not delete the snippet from your `.obsidian/snippet` folder. 12 | - Exclude file from the download / update. You can use the name, or a wildcard. 13 | 14 | 15 | So, the commands added by the plugins are : 16 | - **Adding new Snippet** : Use `https://github.com/username/repo` or `username/repo` to add a new repository and download the present css snippet. 17 | - **Update all snippet** : Update all repository and their snippet (unless you exclude them). 18 | - **Update Specific snippet** : You can just update one snippet using its name. 19 | - **Update Specific Repository** : You can just update one repository using its name. 20 | 21 | 💡Note : The file will be updated only if there is a new commit ! It's not based on the file contents. 22 | 23 | Also, alternatively, you can use the settings tab to add a repository, delete a repository, exclude a snippets, etc. 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 |
⚠️
  • The plugin can't work without the snippets folder in your obsidian : you need to create it before use the plugin for the first time.
  • Each update will erase any edit you made on the snippet !
33 | 34 | ## Installation 35 | - Use [BRAT-42](https://github.com/TfTHacker/obsidian42-brat) to install the plugin. 36 | - Use the community plugin market. 37 | 38 | ## Developpements 39 | - `git clone git@github.com:Mara-Li/obsidian-snippet-downloader.git` 40 | - `npm install` 41 | - `npm run dev` 42 | 43 | *Credit to BRAT-42, where I take some idea and code !* 44 | 45 | 💡If one day BRAT-42 or Obsidian add a similary function, this plugin will be deleted ! 46 | 47 | 🗒️It exists a limit of 60 API call for non identified user... That's mean you can download more than 60 times in a row ! 48 | -------------------------------------------------------------------------------- /Snippet-downloader/modals/updateSnippets.ts: -------------------------------------------------------------------------------- 1 | import {App, FuzzySuggestModal} from "obsidian"; 2 | import {SnippetDownloaderSettings, SnippetRepo} from "../settings"; 3 | import {updateRepo, updateSpecificSnippet} from "../addSnippets"; 4 | import snippetDownloader from "../main"; 5 | import {basename, searchExcluded} from "../utils"; 6 | 7 | interface RepoUpdate { 8 | repoName: string; 9 | repoUrl: string; 10 | } 11 | 12 | export interface SnippetUpdate { 13 | repo: string; 14 | snippetPath: string; 15 | } 16 | 17 | function getAllRepo(settings: SnippetDownloaderSettings){ 18 | const repoAll=[]; 19 | for(const repo of settings.snippetList){ 20 | repoAll.push({ 21 | repoName: repo.repo, 22 | repoUrl: '' 23 | }); 24 | } 25 | return repoAll 26 | } 27 | 28 | export function getAllSnippet(settings: SnippetDownloaderSettings) { 29 | const allSnippet: SnippetUpdate[] = []; 30 | for (const snippet of settings.snippetList) { 31 | for (const snippetContent of snippet.snippetsContents) { 32 | if (snippetContent.name !== 'obsidian.css' && !searchExcluded(settings.excludedSnippet, snippetContent.name) && !searchExcluded(settings.errorSnippet, snippetContent.name)) { 33 | allSnippet.push({ 34 | repo: snippet.repo, 35 | snippetPath: snippetContent.name, 36 | }); 37 | } 38 | } 39 | } 40 | return allSnippet 41 | } 42 | 43 | export class RepoDownloader extends FuzzySuggestModal { 44 | app: App; 45 | settings: SnippetDownloaderSettings; 46 | plugin: snippetDownloader; 47 | 48 | constructor(app: App, settings: SnippetDownloaderSettings, plugin:snippetDownloader){ 49 | super(app); 50 | this.settings = settings; 51 | this.plugin = plugin; 52 | } 53 | 54 | getItemText(item: RepoUpdate): string { 55 | return item.repoName 56 | } 57 | getItems(): RepoUpdate[] { 58 | return getAllRepo(this.settings) 59 | } 60 | 61 | async onChooseItem(item: RepoUpdate, evt: MouseEvent | KeyboardEvent) { 62 | const allSettings = await updateRepo(item.repoName, this.settings.snippetList, this.app.vault, this.settings.excludedSnippet, this.settings.errorSnippet); 63 | await this.plugin.updateList(allSettings); 64 | } 65 | 66 | } 67 | 68 | export class SpecificSnippetDownloader extends FuzzySuggestModal { 69 | app: App; 70 | settings: SnippetDownloaderSettings; 71 | plugin: snippetDownloader; 72 | 73 | constructor(app: App, settings: SnippetDownloaderSettings, plugin: snippetDownloader) { 74 | super(app); 75 | this.settings = settings; 76 | this.plugin = plugin; 77 | } 78 | 79 | getItemText(item: SnippetUpdate): string { 80 | return basename(item.snippetPath); 81 | } 82 | 83 | getItems(): SnippetUpdate[] { 84 | return getAllSnippet(this.settings) 85 | } 86 | 87 | async onChooseItem(item: SnippetUpdate, evt: MouseEvent | KeyboardEvent) { 88 | const newList = await updateSpecificSnippet(item, this.settings); 89 | await this.plugin.updateList(newList); 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release Obsidian plugin 2 | 3 | on: 4 | workflow_dispatch: 5 | push: 6 | tags: 7 | - "*" 8 | env: 9 | PLUGIN_NAME: obsidian-snippet-downloader # Change this to match the id of your plugin. 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Use Node.js 18 | uses: actions/setup-node@v1 19 | with: 20 | node-version: "14.x" 21 | 22 | - name: Build 23 | id: build 24 | run: | 25 | npm install 26 | npm run build 27 | mkdir ${{ env.PLUGIN_NAME }} 28 | cp main.js manifest.json ${{ env.PLUGIN_NAME }} 29 | zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }} 30 | ls 31 | echo "::set-output name=tag_name::$(git tag --sort version:refname | tail -n 1)" 32 | npx rexreplace "^.*?#+\s\[.*?\n.*?(?=\s*#+\s\[)" "_" -s -M -G -m -o "CHANGELOG.md" > CHANGELOG-LATEST.md 33 | - name: Create Release 34 | id: create_release 35 | uses: actions/create-release@v1 36 | env: 37 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 38 | VERSION: ${{ github.ref }} 39 | with: 40 | tag_name: ${{ github.ref }} 41 | release_name: ${{ github.ref }} 42 | body_path: CHANGELOG-LATEST.md 43 | draft: false 44 | prerelease: false 45 | 46 | - name: Upload zip file 47 | id: upload-zip 48 | uses: actions/upload-release-asset@v1 49 | env: 50 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 51 | with: 52 | upload_url: ${{ steps.create_release.outputs.upload_url }} 53 | asset_path: ./${{ env.PLUGIN_NAME }}.zip 54 | asset_name: ${{ env.PLUGIN_NAME }}-${{ steps.build.outputs.tag_name }}.zip 55 | asset_content_type: application/zip 56 | 57 | - name: Upload main.js 58 | id: upload-main 59 | uses: actions/upload-release-asset@v1 60 | env: 61 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 62 | with: 63 | upload_url: ${{ steps.create_release.outputs.upload_url }} 64 | asset_path: ./main.js 65 | asset_name: main.js 66 | asset_content_type: text/javascript 67 | 68 | - name: Upload manifest.json 69 | id: upload-manifest 70 | uses: actions/upload-release-asset@v1 71 | env: 72 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 73 | with: 74 | upload_url: ${{ steps.create_release.outputs.upload_url }} 75 | asset_path: ./manifest.json 76 | asset_name: manifest.json 77 | asset_content_type: application/json 78 | -------------------------------------------------------------------------------- /.github/workflows/npm_release.yml: -------------------------------------------------------------------------------- 1 | name: Release Obsidian plugin 2 | 3 | on: 4 | workflow_dispatch: 5 | push: 6 | tags: 7 | - "*" 8 | env: 9 | PLUGIN_NAME: obsidian-snippet-downloader # Change this to match the id of your plugin. 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Use Node.js 18 | uses: actions/setup-node@v3 19 | with: 20 | node-version: 18 21 | 22 | - name: Build 23 | id: build 24 | run: | 25 | npm install 26 | npm run build 27 | mkdir ${{ env.PLUGIN_NAME }} 28 | cp main.js manifest.json styles.css ${{ env.PLUGIN_NAME }} 29 | zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }} 30 | ls 31 | echo "::set-output name=tag_name::$(git tag --sort version:refname | tail -n 1)" 32 | npx rexreplace "^.*?#+\s\[.*?\n.*?(?=\s*#+\s\[)" "_" -s -M -G -m -o "CHANGELOG.md" > CHANGELOG-LATEST.md 33 | - name: Create Release 34 | id: create_release 35 | uses: actions/create-release@v1 36 | env: 37 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 38 | VERSION: ${{ github.ref }} 39 | with: 40 | tag_name: ${{ github.ref }} 41 | release_name: ${{ github.ref }} 42 | body_path: CHANGELOG-LATEST.md 43 | draft: false 44 | prerelease: false 45 | 46 | - name: Upload zip file 47 | id: upload-zip 48 | uses: actions/upload-release-asset@v1 49 | env: 50 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 51 | with: 52 | upload_url: ${{ steps.create_release.outputs.upload_url }} 53 | asset_path: ./${{ env.PLUGIN_NAME }}.zip 54 | asset_name: ${{ env.PLUGIN_NAME }}-${{ steps.build.outputs.tag_name }}.zip 55 | asset_content_type: application/zip 56 | 57 | - name: Upload main.js 58 | id: upload-main 59 | uses: actions/upload-release-asset@v1 60 | env: 61 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 62 | with: 63 | upload_url: ${{ steps.create_release.outputs.upload_url }} 64 | asset_path: ./main.js 65 | asset_name: main.js 66 | asset_content_type: text/javascript 67 | 68 | - name: Upload manifest.json 69 | id: upload-manifest 70 | uses: actions/upload-release-asset@v1 71 | env: 72 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 73 | with: 74 | upload_url: ${{ steps.create_release.outputs.upload_url }} 75 | asset_path: ./manifest.json 76 | asset_name: manifest.json 77 | asset_content_type: application/json 78 | 79 | - name: Upload styles.css 80 | id: upload-css 81 | uses: actions/upload-release-asset@v1 82 | env: 83 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 84 | with: 85 | upload_url: ${{ steps.create_release.outputs.upload_url }} 86 | asset_path: ./styles.css 87 | asset_name: styles.css 88 | asset_content_type: text/css 89 | 90 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | ### [2.0.1](https://github.com/Mara-Li/obsidian-snippet-downloader/compare/2.0.0...2.0.1) (2022-08-22) 3 | 4 | 5 | ### Bug Fixes 6 | 7 | * folder path not found ([a1009e7](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/a1009e7267a022ce9cbc1a4801a56c12116abb71)) 8 | 9 | ## [2.0.0](https://github.com/Mara-Li/obsidian-snippet-downloader/compare/1.4.3...2.0.0) (2022-08-22) 10 | 11 | 12 | ### ⚠ BREAKING CHANGES 13 | 14 | * Fix regex generation 15 | 16 | ### Features 17 | 18 | * add commands directly on settings ([1cc042f](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/1cc042fc41d7d7bba8248f332a949eaa0f43fb2a)) 19 | 20 | 21 | ### Bug Fixes 22 | 23 | * Fix regex generation ([7f65c84](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/7f65c84de5a17b0eac2784b3b5cc8f1cd516a408)) 24 | 25 | ### [1.4.4](https://github.com/Mara-Li/obsidian-snippet-downloader/compare/1.4.3...1.4.4) (2022-04-23) 26 | 27 | ### 1.4.3 (2022-04-22) 28 | 29 | ### [1.4.2](https://github.com/Mara-Li/obsidian-snippet-downloader/compare/1.4.0...1.4.2) (2022-04-22) 30 | 31 | 32 | ### Bug Fixes 33 | 34 | * Adding regex in case of glob doest work ([bec5715](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/bec571581a968153a8424bfe393193d405bc0c6f)) 35 | 36 | ### 1.4.1 (2022-04-22) 37 | 38 | 39 | ### Bug Fixes 40 | 41 | * Adding regex in case of glob doest work ([bec5715](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/bec571581a968153a8424bfe393193d405bc0c6f)) 42 | 43 | ## [1.4.0](https://github.com/Mara-Li/obsidian-snippet-downloader/compare/1.3.0...1.4.0) (2022-04-15) 44 | 45 | 46 | ### Features 47 | 48 | * Clean data.json file when repo is excluded ([f23844c](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/f23844c42959f13a4418d42c95f07b856e5fcb36)) 49 | * You can now add to exclude specific snippet. ([93c0a06](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/93c0a0639cb1506d75d657c5179e1a042ca0b124)) 50 | 51 | 52 | ### Bug Fixes 53 | 54 | * Exclude error downloaded snippet ([7b4319d](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/7b4319d2a36c346022a90cc200699cf1fdd83784)) 55 | * Repo not found using owner/repo ([f4b56c7](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/f4b56c72fce2d00367c816f0553cd8da72e04458)) 56 | 57 | ## [1.3.0](https://github.com/Mara-Li/obsidian-snippet-downloader/compare/1.2.1...1.3.0) (2022-04-14) 58 | 59 | 60 | ### Features 61 | 62 | * If snippet can be downloaded, it will be automatically added to excluded snippet. ([e183502](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/e1835023e279845949a546ebfa8444143b668518)) 63 | 64 | ### [1.2.1](https://github.com/Mara-Li/obsidian-snippet-downloader/compare/1.2.0...1.2.1) (2022-04-14) 65 | 66 | ## [1.2.0](https://github.com/Mara-Li/obsidian-snippet-downloader/compare/1.1.0...1.2.0) (2022-04-14) 67 | 68 | 69 | ### Features 70 | 71 | * Adding checkCallback to avoid commands list if no snippet donwloaded ([0d2a7c1](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/0d2a7c1e73af1ac46e9f6e96b425fc30835866a4)) 72 | 73 | ## [1.1.0](https://github.com/Mara-Li/obsidian-snippet-downloader/compare/1.0.0...1.1.0) (2022-04-14) 74 | 75 | 76 | ### Features 77 | 78 | * Search repo & snippet updating ([9e75a23](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/9e75a2330cbe72da27cc8b770ad05708da7ad2c1)) 79 | * Use glob to match excluded files ([66989da](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/66989da74cafa496f3f2b052ca98f840eaa79160)) 80 | 81 | 82 | ### Bug Fixes 83 | 84 | * Base64 for mobile ([fb0edad](https://github.com/Mara-Li/obsidian-snippet-downloader/commit/fb0edad15715874e3ed48d11ecd314ae4646d0a5)) 85 | -------------------------------------------------------------------------------- /Snippet-downloader/addSnippets.ts: -------------------------------------------------------------------------------- 1 | import {SnippetDownloaderSettings, SnippetRepo} from "./settings"; 2 | import {Notice, Vault} from "obsidian"; 3 | import { 4 | checkLastUpdate, 5 | downloadSnippet, grabLastCommitDate, 6 | listSnippetfromRepo 7 | } from "./downloader"; 8 | import {basename, searchExcluded} from "./utils"; 9 | import {SnippetUpdate} from "./modals/updateSnippets"; 10 | import {removeSnippetFromExcluded} from "./removeSnippet" 11 | 12 | export async function addSnippet(repoPath: string, settings: SnippetDownloaderSettings, vault: Vault) { 13 | const snippetList = settings.snippetList; 14 | let excludedSnippet = settings.errorSnippet; 15 | const catchErrors: string[] = []; 16 | if (!snippetList.some(snippet => snippet.repo === repoPath)) { 17 | const newSnippetList = await listSnippetfromRepo(repoPath, settings); 18 | if (newSnippetList.length === 0) { 19 | new Notice('Error 😿, snippet or repository not found') 20 | return snippetList; 21 | } 22 | snippetList.push({ 23 | repo: repoPath, 24 | snippetsContents: await listSnippetfromRepo(repoPath, settings) 25 | }) 26 | const snippet = snippetList.find(snippet => snippet.repo === repoPath) 27 | for (const snippetContents of snippet.snippetsContents) { 28 | const success=await downloadSnippet(repoPath, snippetContents.name, vault) 29 | if (!success) { 30 | excludedSnippet += snippetContents.name.replace('.css', '') + ', '; 31 | catchErrors.push(snippetContents.name.replace('.css', '')); 32 | } 33 | } 34 | let messageNotice = `Successfully added ${repoPath}. ${newSnippetList.length} snippets added. 🎉` 35 | if (catchErrors.length > 0) { 36 | messageNotice += `\n${catchErrors.length} snippets not added😿: ${catchErrors.join(', ')}` 37 | } 38 | new Notice(messageNotice); 39 | return [snippetList, excludedSnippet] 40 | } 41 | new Notice ('Error : this repo is already in the list 😿'); 42 | return [snippetList, excludedSnippet] 43 | } 44 | 45 | export async function updateRepo(repoPath: string, snippetList: SnippetRepo[], vault: Vault, excludedSnippets: string, errorSnippets: string) { 46 | const snippet = snippetList.find(snippet => snippet.repo === repoPath); 47 | if (snippet) { 48 | for (const snippetContent of snippet.snippetsContents) { 49 | if (await checkLastUpdate(snippetContent, repoPath) && (snippetContent.name !== 'obsidian.css') && (!searchExcluded(excludedSnippets, snippetContent.name)) && (!searchExcluded(errorSnippets, snippetContent.name))) 50 | { 51 | const successDownloaded=await downloadSnippet(repoPath, snippetContent.name, vault) 52 | if (successDownloaded) { 53 | snippetContent.lastUpdate = await grabLastCommitDate(repoPath, snippetContent.name); 54 | } else { 55 | errorSnippets += snippetContent.name.replace('.css', '') + ', '; 56 | } 57 | } 58 | } 59 | } 60 | snippetList = removeSnippetFromExcluded(repoPath,snippetList, errorSnippets, excludedSnippets); 61 | new Notice(`${repoPath} successfully updated 🎉`); 62 | return [snippetList, errorSnippets]; 63 | } 64 | 65 | export async function updateSpecificSnippet(item: SnippetUpdate, settings: SnippetDownloaderSettings) { 66 | let listSnippet = settings.snippetList 67 | let excludedSnippet = settings.errorSnippet 68 | const snippet = listSnippet.find(snippet => snippet.repo === item.repo); 69 | const snippetsRep = snippet.snippetsContents.find(snippet => snippet.name === item.snippetPath); 70 | if (await checkLastUpdate(snippetsRep, item.repo)) { 71 | const successDownload = await downloadSnippet(item.repo, snippetsRep.name, this.app.vault); 72 | if (successDownload) { 73 | snippetsRep.lastUpdate = await grabLastCommitDate(item.repo, snippetsRep.name); 74 | new Notice(`${basename(item.snippetPath)} has been updated 🎉`); 75 | return [listSnippet, 76 | excludedSnippet]; 77 | } else { 78 | excludedSnippet =excludedSnippet + item.snippetPath.replace('.css', '') + ', '; 79 | listSnippet = removeSnippetFromExcluded(item.repo,listSnippet, excludedSnippet, settings.excludedSnippet); 80 | return [listSnippet, 81 | excludedSnippet]; 82 | } 83 | } 84 | listSnippet = removeSnippetFromExcluded(item.repo,listSnippet, excludedSnippet, settings.excludedSnippet); 85 | new Notice (`${basename(item.snippetPath)} is already up to date 💡`); 86 | return [listSnippet, 87 | excludedSnippet]; 88 | } 89 | -------------------------------------------------------------------------------- /Snippet-downloader/downloader.ts: -------------------------------------------------------------------------------- 1 | import {Octokit} from "@octokit/core"; 2 | import { Base64 } from "js-base64"; 3 | import { ResponseHeaders } from "@octokit/types"; 4 | import {normalizePath, Vault, request} from "obsidian"; 5 | import { 6 | SnippetDownloaderSettings, 7 | SnippetInformation, 8 | } from "./settings"; 9 | import {searchExcluded, basename} from "./utils"; 10 | 11 | //@ts-ignore 12 | async function fetchListSnippet(repoRecur: { headers?: ResponseHeaders; status?: 200; url?: string; data: any; }, snippetList: SnippetInformation[], settings: SnippetDownloaderSettings, repoPath: string) { 13 | for (const data of repoRecur.data.tree) { 14 | if (data.path.endsWith('.css') && !searchExcluded(settings.excludedSnippet, data.path) && data.path != 'obsidian.css' && !searchExcluded(settings.errorSnippet, data.path)) { 15 | const snippetName = data.path 16 | const snippetLastUpdate = await grabLastCommitDate(repoPath, data.path); 17 | snippetList.push({ 18 | name: snippetName, 19 | lastUpdate: snippetLastUpdate 20 | }) 21 | } 22 | } 23 | return snippetList; 24 | } 25 | 26 | async function grabLastCommitInfo(repoPath: string, filepath:string) { 27 | const repoName = repoPath.replace('https://github.com/', ''); 28 | const url = `https://api.github.com/repos/${repoName}/commits?path=${encodeURIComponent(filepath)}&page=1&per_page=1`; 29 | try { 30 | const response = await request({url:url}) 31 | return (response === "404: Not Found" ? null : JSON.parse(response)); 32 | } catch (error) { 33 | console.log("error in grabcommitinfo", error) 34 | } 35 | } 36 | 37 | export async function grabLastCommitDate(repoPath:string, filepath:string) { 38 | const test = await grabLastCommitInfo(repoPath, filepath); 39 | console.log(`Testing from ${repoPath} : ${filepath} => ${test[0].commit.author.date}`) 40 | //@ts-ignore 41 | if (test[0].commit.author.date) { 42 | //@ts-ignore 43 | return test[0].commit.author.date; 44 | } else { 45 | return ""; 46 | } 47 | } 48 | 49 | export async function listSnippetfromRepo(repoPath: string, settings: SnippetDownloaderSettings): Promise { 50 | const octokit = new Octokit(); 51 | const repo = repoPath.replace('https://github.com/', '') 52 | const owner = repo.split('/')[0] 53 | const repoName = repo.split('/')[1] 54 | console.log(`Repo: ${repoPath}, owner: ${owner}, repoName: ${repoName}`) 55 | const snippetList: SnippetInformation[] | PromiseLike = []; 56 | try { 57 | const repoRecur = await octokit.request('GET /repos/{owner}/{repo}/git/trees/{tree_sha}', { 58 | owner: owner, 59 | repo: repoName, 60 | tree_sha: 'main', 61 | recursive: "true" 62 | }); 63 | return await fetchListSnippet(repoRecur, snippetList, settings, repoPath); 64 | 65 | } catch (e) { 66 | try { 67 | const repoRecur = await octokit.request('GET /repos/{owner}/{repo}/git/trees/{tree_sha}', { 68 | owner: owner, 69 | repo: repoName, 70 | tree_sha: 'main', 71 | recursive: "true" 72 | }); 73 | return await fetchListSnippet(repoRecur, snippetList, settings, repoPath); 74 | } catch (e) { 75 | console.log(e) 76 | return []; 77 | } 78 | } 79 | } 80 | 81 | export async function checkLastUpdate(snippetName:SnippetInformation, repoPath: string) { 82 | const oldDate = new Date (snippetName.lastUpdate); 83 | const newDate= new Date(await grabLastCommitDate(repoPath, snippetName.name)); 84 | return (oldDate < newDate) 85 | } 86 | 87 | export async function downloadSnippet(repoPath: string, snippetName: string, vault:Vault) { 88 | const repo = repoPath.replace('https://github.com/', '') 89 | const owner = repo.split('/')[0] 90 | const repoName = repo.split('/')[1] 91 | const octokit = new Octokit(); 92 | const fileName = basename(snippetName) 93 | const filePath = normalizePath(vault.configDir + "/snippets/" + fileName) 94 | try { 95 | const file = await octokit.request('GET /repos/{owner}/{repo}/contents/{path}', { 96 | owner: owner, 97 | repo: repoName, 98 | path: snippetName 99 | }); 100 | console.log(file.status) 101 | if (file.status === 200) { 102 | // @ts-ignore 103 | const fileContent = Base64.decode(file.data.content); 104 | const adapter = vault.adapter 105 | await adapter.write(filePath, fileContent) 106 | return true 107 | } else { 108 | return false 109 | } 110 | } catch (e) { 111 | console.log(e) 112 | } 113 | } 114 | 115 | -------------------------------------------------------------------------------- /Snippet-downloader/main.ts: -------------------------------------------------------------------------------- 1 | import {Plugin} from 'obsidian'; 2 | import { 3 | DEFAULT_SETTINGS, 4 | SnippetDownloaderSettings, 5 | SnippetDownloaderTabs, SnippetRepo 6 | } from "./settings"; 7 | import {SnippetDownloaderModals} from "./modals/simpleCommands"; 8 | import {RepoDownloader, SpecificSnippetDownloader} from "./modals/updateSnippets"; 9 | import {ExcludeSnippet} from "./modals/excludeSnippet"; 10 | import {addSnippet, updateRepo} from "./addSnippets"; 11 | 12 | export default class snippetDownloader extends Plugin { 13 | settings: SnippetDownloaderSettings; 14 | 15 | async updateAllSnippets() { 16 | if (this.settings.snippetList.length > 0) { 17 | const snippetList = this.settings.snippetList; 18 | const errorSnippet = this.settings.errorSnippet; 19 | const excludedSnippet = this.settings.excludedSnippet; 20 | let updatedSettings = [errorSnippet, snippetList]; 21 | for (const repoName of snippetList) { 22 | //@ts-ignore 23 | updatedSettings= await updateRepo(repoName.repo, snippetList, this.app.vault, excludedSnippet, errorSnippet); 24 | this.settings.snippetList = updatedSettings[1]; 25 | this.settings.errorSnippet = updatedSettings[0]; 26 | } 27 | await this.saveSettings(); 28 | } 29 | } 30 | 31 | async updateList(newSettings: SnippetRepo[] | (string | SnippetRepo[])[]){ 32 | this.settings.snippetList = newSettings[0]; 33 | this.settings.errorSnippet = newSettings[1]; 34 | await this.saveSettings(); 35 | } 36 | 37 | async onload() { 38 | await this.loadSettings(); 39 | 40 | this.addCommand({ 41 | id: 'add-snippet', 42 | name: 'Adding new snippet', 43 | callback: ()=> { 44 | new SnippetDownloaderModals(this.app, async (result) => { 45 | if (result) { 46 | const newSettings = await addSnippet(result.trim(), this.settings, this.app.vault); 47 | await this.updateList(newSettings); 48 | } 49 | }).open(); 50 | } 51 | }); 52 | 53 | this.addCommand({ 54 | id: 'update-all-snippets', 55 | name: 'Update all snippets', 56 | //@ts-ignore 57 | checkCallback: async (checking: boolean) => { 58 | if (this.settings.snippetList.length > 0) { 59 | if (!checking) { 60 | const snippetList = this.settings.snippetList; 61 | const errorSnippet = this.settings.errorSnippet; 62 | const excludedSnippet = this.settings.excludedSnippet; 63 | let updatedSettings = [errorSnippet, snippetList]; 64 | for (const repoName of snippetList) { 65 | //@ts-ignore 66 | updatedSettings= await updateRepo(repoName.repo, snippetList, this.app.vault, excludedSnippet, errorSnippet); 67 | await this.updateList(updatedSettings); 68 | } 69 | await this.saveSettings(); 70 | } 71 | return true; 72 | 73 | } return false; 74 | } 75 | }); 76 | 77 | this.addCommand({ 78 | id: 'update-specific-repo', 79 | name: 'Update specific repository', 80 | hotkeys:[], 81 | checkCallback: (checking:boolean) => { 82 | if (this.settings.snippetList.length > 0){ 83 | if (!checking) { 84 | new RepoDownloader(this.app, this.settings, this).open(); 85 | } 86 | return true; 87 | } 88 | return false; 89 | } 90 | }); 91 | 92 | this.addCommand({ 93 | id: 'update-specific-snippet', 94 | name: 'Update specific snippet', 95 | hotkeys:[], 96 | checkCallback: (checking:boolean) => { 97 | if (this.settings.snippetList.length > 0) { 98 | if (!checking) { 99 | new SpecificSnippetDownloader(this.app, this.settings, this).open(); 100 | } 101 | return true; 102 | } 103 | return false; 104 | } 105 | }); 106 | 107 | this.addCommand({ 108 | id: 'remove-specific-snippet', 109 | name: 'Exclude specific snippet', 110 | hotkeys:[], 111 | checkCallback: (checking:boolean) => { 112 | if (this.settings.snippetList.length > 0) { 113 | if (!checking) { 114 | new ExcludeSnippet(this.app, this.settings, this).open(); 115 | } 116 | return true; 117 | } 118 | return false; 119 | } 120 | }) 121 | 122 | this.addSettingTab(new SnippetDownloaderTabs(this.app, this)); 123 | 124 | 125 | } 126 | 127 | onunload() { 128 | 129 | } 130 | 131 | async loadSettings() { 132 | this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData()); 133 | } 134 | 135 | async saveSettings() { 136 | await this.saveData(this.settings); 137 | } 138 | } 139 | -------------------------------------------------------------------------------- /Snippet-downloader/settings.ts: -------------------------------------------------------------------------------- 1 | import { 2 | App, 3 | PluginSettingTab, 4 | Setting, ExtraButtonComponent, ButtonComponent 5 | } from "obsidian"; 6 | import snippetDownloader from "./main"; 7 | import {removeSnippet} from "./removeSnippet"; 8 | import {SnippetDownloaderModals} from "./modals/simpleCommands"; 9 | import {addSnippet, updateRepo, updateSpecificSnippet} from "./addSnippets"; 10 | import {getAllSnippet} from "./modals/updateSnippets"; 11 | import {basename} from "./utils"; 12 | import {addExcludedSnippet, getExcludedSnippets} from "./modals/excludeSnippet"; 13 | 14 | export interface SnippetInformation { 15 | name: string; 16 | lastUpdate: string; 17 | } 18 | 19 | export interface SnippetRepo { 20 | repo: string; 21 | snippetsContents: SnippetInformation[]; 22 | } 23 | 24 | export interface SnippetDownloaderSettings { 25 | snippetList:SnippetRepo[]; 26 | excludedSnippet:string; 27 | errorSnippet: string; 28 | } 29 | 30 | export const DEFAULT_SETTINGS: SnippetDownloaderSettings = { 31 | snippetList: [], 32 | excludedSnippet: "", 33 | errorSnippet: "", 34 | }; 35 | 36 | function getDetailsState(name: string) { 37 | for (let i=0; i < document.getElementsByTagName('details').length; i++) { 38 | const details = document.getElementsByTagName('details')[i] as HTMLDetailsElement; 39 | if (details.innerText.split('\n')[0] === name) { 40 | return details.hasAttribute('open'); 41 | } 42 | } 43 | return true; 44 | } 45 | 46 | function openDetails(name: string, detailsState: boolean) { 47 | const allDetails = document.getElementsByTagName('details'); 48 | for (let i = 0; i{ 81 | span.innerText='Type the snippet name you want to exclude from the list, without the extension.\nYou can also use regex, for example: '; 82 | span.createEl('code', {text: '^(.*)$'}); 83 | span.createEl('span', {text:' will match all snippets.\n\n'}); 84 | span.createEl('a', null, (link)=>{ 85 | link.innerText='You can check your regex here.'; 86 | link.href='https://regex101.com/'; 87 | }) 88 | }) 89 | 90 | new Setting(containerEl) 91 | .setName('Excluded Snippet') 92 | .setDesc(desc_excluder) 93 | .addTextArea(text => text 94 | .setPlaceholder('BadCSS I hate, badCSS*') 95 | .setValue(this.plugin.settings.excludedSnippet) 96 | .onChange(async (value) => { 97 | this.plugin.settings.excludedSnippet = value; 98 | await this.plugin.saveSettings(); 99 | })); 100 | const desc_plugins = document.createDocumentFragment(); 101 | desc_plugins.createEl('span', {text:`The following is a list of the repository added via the command palette ` 102 | }); 103 | desc_plugins.createEl('div', {text:`Click the x button next to a repository to remove it from the list.` 104 | }) 105 | desc_plugins.createEl("b", { text: "Note: " }); 106 | desc_plugins.createEl('span', {text:"This does not delete the linked snippet, this should be done from your "}); 107 | desc_plugins.createEl("code", { text: ".obsidian/snippets" }).setAttribute("style", "font-family: var(--font-monospace)"); 108 | desc_plugins.createEl('span', {text:" folder"} ); 109 | new Setting(containerEl) 110 | .setName('Repository Snippet List') 111 | .setDesc(desc_plugins) 112 | .addButton((btn:ButtonComponent)=>{ 113 | btn 114 | .setIcon('plus') 115 | .setTooltip('Add new repository') 116 | .onClick(async () => { 117 | new SnippetDownloaderModals(this.app, async (result) => { 118 | if (result) { 119 | const newSettings = await addSnippet(result.trim(), this.plugin.settings, this.app.vault); 120 | await this.plugin.updateList(newSettings); 121 | const detailState = getDetailsState(result); 122 | this.display(); 123 | openDetails(result, detailState); 124 | } 125 | }).open(); 126 | }) 127 | }) 128 | .addButton((btn:ButtonComponent)=>{ 129 | btn 130 | .setIcon('install') 131 | .setTooltip('Update all repository') 132 | .onClick(async () => { 133 | this.plugin.updateAllSnippets(); 134 | }) 135 | }); 136 | for (const repoPath of this.plugin.settings.snippetList) { 137 | const details = containerEl.createEl('details'); 138 | 139 | const repoName = repoPath.repo.replace('https://github.com/','') 140 | const summary = details.createEl('summary', { text: repoName }); 141 | summary.addClass('snippets-downloader-summary'); 142 | new Setting(summary) 143 | .setClass('snippets-downloader-options') 144 | .addButton((btn:ButtonComponent)=>{ 145 | btn 146 | .setClass('snippets-downloader-options-button') 147 | .setIcon("cross") 148 | .setTooltip("Delete this repository from the list") 149 | .onClick(async()=>{ 150 | btn.buttonEl.parentElement.remove(); 151 | const newSettings=removeSnippet(repoPath.repo, this.plugin.settings.snippetList, this.plugin.settings.errorSnippet); 152 | await this.plugin.updateList(newSettings); 153 | const detailState = getDetailsState(repoName); 154 | this.display(); 155 | openDetails(repoName, detailState); 156 | }) 157 | }) 158 | .addButton((btn:ButtonComponent)=>{ 159 | btn 160 | .setClass('snippets-downloader-options-button') 161 | .setIcon("sync") 162 | .setTooltip("Update this repository") 163 | .onClick(async()=>{ 164 | const allSettings = await updateRepo(repoPath.repo, this.plugin.settings.snippetList, this.app.vault, this.plugin.settings.excludedSnippet, this.plugin.settings.errorSnippet); 165 | await this.plugin.updateList(allSettings); 166 | }) 167 | }) 168 | for(const snippets of repoPath.snippetsContents) { 169 | new Setting(details) 170 | .setName(basename(snippets.name)) 171 | .setClass('snippets-downloader-settings') 172 | .addExtraButton((btn:ExtraButtonComponent)=>{ 173 | btn 174 | .setTooltip('Update this snippet') 175 | .setIcon('install') 176 | .onClick(async ()=>{ 177 | const updatedList = await updateSpecificSnippet(allSnippets.find(s => snippets.name === s.snippetPath), this.plugin.settings); 178 | await this.plugin.updateList(updatedList); 179 | }) 180 | 181 | }) 182 | .addExtraButton((btn:ExtraButtonComponent)=>{ 183 | btn 184 | .setTooltip('Remove this snippet') 185 | .setIcon('trash') 186 | .onClick(async ()=>{ 187 | btn.extraSettingsEl.parentElement.parentElement.remove(); 188 | const updatedList = await addExcludedSnippet(getExcludedSnippets(this.plugin.settings).find(s => snippets.name === s.snippetPath), this.plugin.settings); 189 | await this.plugin.updateList(updatedList); 190 | }) 191 | }) 192 | } 193 | 194 | } 195 | } 196 | } 197 | 198 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------