├── .npmrc ├── .eslintignore ├── screenshots ├── screenshot-list.png └── screenshot-month.png ├── versions.json ├── .editorconfig ├── manifest.json ├── .gitignore ├── tsconfig.json ├── version-bump.mjs ├── .eslintrc ├── css ├── main.css └── calendar-overrides.css ├── .github ├── FUNDING.yml └── workflows │ └── release.yml ├── package.json ├── esbuild.config.mjs ├── src ├── embedded.ts ├── calendar.ts ├── view.ts ├── main.ts ├── settings.ts └── parser.ts ├── README.md └── LICENSE /.npmrc: -------------------------------------------------------------------------------- 1 | tag-version-prefix="" -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | npm node_modules 2 | build -------------------------------------------------------------------------------- /screenshots/screenshot-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sandorex/set-in-obsidian-plugin/HEAD/screenshots/screenshot-list.png -------------------------------------------------------------------------------- /screenshots/screenshot-month.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sandorex/set-in-obsidian-plugin/HEAD/screenshots/screenshot-month.png -------------------------------------------------------------------------------- /versions.json: -------------------------------------------------------------------------------- 1 | { 2 | "1.0.9": "1.0.0", 3 | "1.0.10": "1.0.0", 4 | "1.0.11": "1.0.0", 5 | "1.0.12": "1.1.0", 6 | "1.0.13": "1.1.0" 7 | } -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # top-most EditorConfig file 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | end_of_line = lf 7 | insert_final_newline = true 8 | indent_style = tab 9 | indent_size = 4 10 | tab_width = 4 11 | quote_type = single 12 | -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "set-in-obsidian", 3 | "name": "Set In Obsidian", 4 | "version": "1.0.13", 5 | "minAppVersion": "1.1.0", 6 | "description": "Plugin for time planning", 7 | "author": "Sandorex", 8 | "authorUrl": "https://github.com/sandorex", 9 | "isDesktopOnly": false, 10 | "fundingUrl": "https://ko-fi.com/sanodrex" 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 | /main.css 15 | /styles.css 16 | 17 | # Exclude sourcemaps 18 | *.map 19 | 20 | # obsidian 21 | data.json 22 | 23 | # Exclude macOS Finder (System Explorer) View States 24 | .DS_Store 25 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "strictNullChecks": true, 4 | "allowSyntheticDefaultImports": true, 5 | "baseUrl": ".", 6 | "inlineSourceMap": true, 7 | "inlineSources": true, 8 | "module": "ESNext", 9 | "target": "ES6", 10 | "allowJs": true, 11 | "noImplicitAny": true, 12 | "moduleResolution": "node", 13 | "importHelpers": true, 14 | "isolatedModules": true, 15 | "lib": [ 16 | "DOM", 17 | "ES5", 18 | "ES6", 19 | "ES7" 20 | ] 21 | }, 22 | "include": [ 23 | "src/*.ts" 24 | ] 25 | } 26 | -------------------------------------------------------------------------------- /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 | } -------------------------------------------------------------------------------- /css/main.css: -------------------------------------------------------------------------------- 1 | @import url(calendar-overrides.css); 2 | 3 | .set-in-obsidian-wrapper > h4 { 4 | text-align: center; 5 | margin-top: 0; 6 | margin-bottom: 10px; 7 | } 8 | 9 | .set-in-obsidian-wrapper { 10 | width: 100%; 11 | height: 100%; 12 | margin-top: 15px; 13 | } 14 | 15 | .set-in-obsidian-developer-settings .setting-item-description { 16 | color: rgb(170, 0, 0); 17 | font-weight: bold; 18 | } 19 | 20 | .set-in-obsidian-fullcalendar-options textarea { 21 | resize: none; 22 | height: 100%; 23 | width: 100%; 24 | min-height: 100px; 25 | min-width: 300px; 26 | } 27 | 28 | .set-in-obsidian-success { 29 | border-color: lightgreen; 30 | } 31 | 32 | .set-in-obsidian-fail { 33 | border-color: red; 34 | } 35 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: sandorex 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: sandorex 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 13 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 14 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "set-in-obsidian", 3 | "version": "1.0.13", 4 | "description": "Plugin for time planning", 5 | "main": "main.js", 6 | "scripts": { 7 | "dev": "node esbuild.config.mjs", 8 | "build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production", 9 | "version": "node version-bump.mjs && git add package.json manifest.json versions.json" 10 | }, 11 | "keywords": [], 12 | "author": "Sandorex", 13 | "license": "GPL-3.0-only", 14 | "devDependencies": { 15 | "@fullcalendar/core": "^6.0.2", 16 | "@fullcalendar/daygrid": "^6.0.2", 17 | "@fullcalendar/list": "^6.0.2", 18 | "@fullcalendar/resource": "^6.0.2", 19 | "@fullcalendar/resource-timeline": "^6.0.2", 20 | "@fullcalendar/rrule": "^6.0.2", 21 | "@fullcalendar/timegrid": "^6.0.2", 22 | "@types/moment": "2.13.0", 23 | "@types/node": "^18.11.18", 24 | "@typescript-eslint/eslint-plugin": "^5.48.0", 25 | "@typescript-eslint/parser": "^5.48.0", 26 | "builtin-modules": "^3.3.0", 27 | "esbuild": "0.16.15", 28 | "obsidian": "latest", 29 | "rrule": "^2.7.1", 30 | "tslib": "2.4.1", 31 | "typescript": "4.9.4" 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /esbuild.config.mjs: -------------------------------------------------------------------------------- 1 | import builtins from 'builtin-modules'; 2 | import esbuild from "esbuild"; 3 | import process from "process"; 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: { css: banner, }, 16 | entryPoints: ['css/main.css'], 17 | bundle: true, 18 | watch: !prod, 19 | logLevel: "info", 20 | outfile: 'styles.css', 21 | }).catch(() => process.exit(1)); 22 | 23 | esbuild.build({ 24 | banner: { 25 | js: banner, 26 | }, 27 | entryPoints: ['src/main.ts'], 28 | bundle: true, 29 | external: [ 30 | 'obsidian', 31 | 'electron', 32 | '@codemirror/autocomplete', 33 | '@codemirror/closebrackets', 34 | '@codemirror/collab', 35 | '@codemirror/commands', 36 | '@codemirror/comment', 37 | '@codemirror/fold', 38 | '@codemirror/gutter', 39 | '@codemirror/highlight', 40 | '@codemirror/history', 41 | '@codemirror/language', 42 | '@codemirror/lint', 43 | '@codemirror/matchbrackets', 44 | '@codemirror/panel', 45 | '@codemirror/rangeset', 46 | '@codemirror/rectangular-selection', 47 | '@codemirror/search', 48 | '@codemirror/state', 49 | '@codemirror/stream-parser', 50 | '@codemirror/text', 51 | '@codemirror/tooltip', 52 | '@codemirror/view', 53 | ...builtins], 54 | format: 'cjs', 55 | watch: !prod, 56 | target: 'es2016', 57 | logLevel: "info", 58 | sourcemap: prod ? false : 'inline', 59 | treeShaking: true, 60 | outfile: 'main.js', 61 | }).catch(() => process.exit(1)); 62 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release Obsidian Plugin 2 | 3 | # to make a release: 4 | # increment version in package.json 5 | # $ npm run version 6 | # $ git commit 7 | # $ git tag 8 | # $ git push && git push --tags 9 | 10 | # push only on tags 11 | on: 12 | push: 13 | tags: 14 | - '*' 15 | 16 | permissions: 17 | contents: write 18 | 19 | env: 20 | PLUGIN_NAME: set-in-obsidian 21 | 22 | jobs: 23 | build: 24 | runs-on: ubuntu-latest 25 | steps: 26 | - uses: actions/checkout@v2 27 | with: 28 | fetch-depth: 0 29 | 30 | - name: Use Node.js 31 | uses: actions/setup-node@v1 32 | with: 33 | node-version: '16.x' 34 | 35 | # Get the version from git tag 36 | - name: Get Version 37 | id: version 38 | run: | 39 | echo "::set-output name=tag::$(git describe --abbrev=0 --tags)" 40 | 41 | # Build the plugin 42 | - name: Build 43 | id: build 44 | run: | 45 | npm install 46 | npm run build --if-present 47 | 48 | # Package the required files into a zip 49 | - name: Package 50 | run: | 51 | mkdir ${{ env.PLUGIN_NAME }} 52 | cp main.js manifest.json styles.css ${{ env.PLUGIN_NAME }} 53 | zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }} 54 | 55 | - name: Release 56 | uses: softprops/action-gh-release@v1 57 | with: 58 | name: Version ${{ steps.version.outputs.tag }} 59 | fail_on_unmatched_files: yes 60 | files: | 61 | ${{ env.PLUGIN_NAME }}.zip 62 | manifest.json 63 | main.js 64 | styles.css 65 | -------------------------------------------------------------------------------- /css/calendar-overrides.css: -------------------------------------------------------------------------------- 1 | /* (https://github.com/davish/obsidian-full-calendar/blob/91f758efccbf58d1bed94b9729840a803d870304/src/ui/overrides.css) 2 | Styling based on css from davish/obsidian-full-calendar plugin 3 | Modified by Sandorex 2022-2023 4 | Licensed under MIT License 5 | 6 | EVERYTHING MUST BE IN .set-in-obsidian-timeline SO THAT ANY OTHER PLUGIN IS NOT AFFECTED 7 | */ 8 | 9 | .is-phone .set-in-obsidian-timeline { 10 | height: calc(100% - 4rem); 11 | } 12 | 13 | .set-in-obsidian-timeline { 14 | height: 90%; 15 | width: calc(100% - 20px); 16 | margin-left: auto; 17 | margin-right: auto; 18 | padding-bottom: 30px; 19 | 20 | --fc-button-text-color: var(--text-normal); 21 | --fc-button-bg-color: var(--interactive-normal); 22 | --fc-button-border-color: var(--interactive-normal); 23 | 24 | --fc-button-hover-bg-color: var(--interactive-hover); 25 | --fc-button-hover-border-color: var(--interactive-hover); 26 | 27 | --fc-button-active-border-color: var(--interactive-accent); 28 | --fc-button-active-bg-color: var(--interactive-accent); 29 | 30 | --fc-event-border-color: var(--interactive-accent); 31 | --fc-event-bg-color: var(--interactive-accent); 32 | --fc-event-text-color: var(--text-on-accent); 33 | 34 | --fc-list-event-hover-bg-color: var(--background-secondary); 35 | --fc-neutral-bg-color: var(--background-primary-alt); 36 | 37 | --fc-page-bg-color: var(--background-primary); 38 | --fc-border-color: var(--background-modifier-border); 39 | 40 | --fc-now-indicator-color: var(--text-error-hover); 41 | 42 | --fc-more-link-bg-color: var(--background-primary-alt); 43 | --fc-more-link-text-color: var(--text-accent); 44 | 45 | --fc-today-bg-color: var(--background-modifier-cover); 46 | 47 | --fc-neutral-text-color: var(--text-muted); 48 | --fc-neutral-bg-color: var(--interactive-normal); 49 | 50 | --fc-highlight-color: var(--text-highlight-bg); 51 | --fc-bg-event-color: var(--background-modifier-success); 52 | --fc-non-business-color: var(--background-modifier-box-shadow); 53 | } 54 | 55 | .set-in-obsidian-timeline a { 56 | text-decoration-line: none; 57 | } 58 | 59 | .set-in-obsidian-timeline .fc-button-active { 60 | color: var(--text-on-accent) !important; 61 | } 62 | 63 | .set-in-obsidian-timeline .fc-button { 64 | border: 0px solid transparent !important; 65 | line-height: 1 !important; 66 | padding: var(--size-4-1) var(--size-4-3) !important; 67 | line-height: 1 !important; 68 | } 69 | 70 | .set-in-obsidian-timeline .fc-timegrid-now-indicator-line, 71 | .set-in-obsidian-timeline .fc-timegrid-now-indicator-arrow { 72 | color: red; 73 | } 74 | 75 | .set-in-obsidian-wrapper-view .fc-header-toolbar, 76 | .set-in-obsidian-wrapper-view .fc-footer-toolbar { 77 | margin-bottom: 15px !important; 78 | } 79 | -------------------------------------------------------------------------------- /src/embedded.ts: -------------------------------------------------------------------------------- 1 | import { Calendar, CalendarOptions } from '@fullcalendar/core'; 2 | import { MarkdownRenderChild, TFile } from 'obsidian'; 3 | import { CALENDAR_OPTIONS, CALENDAR_OPTIONS_AFTER, EmbeddedCalendarOptions } from './calendar'; 4 | import SetInObsidianPlugin from './main'; 5 | import { gatherEventsFromFiles, gatherGlobalEvents, parseListItem } from './parser'; 6 | 7 | // TODO: better errors in case of invalid options etc 8 | // TODO: make code more readable 9 | export class EmbeddedCalendar extends MarkdownRenderChild { 10 | readonly plugin: SetInObsidianPlugin; 11 | readonly calendar: Calendar; 12 | 13 | constructor(containerEl: HTMLElement, eoptions: EmbeddedCalendarOptions, filePath: string, plugin: SetInObsidianPlugin) { 14 | super(containerEl); 15 | this.plugin = plugin; 16 | 17 | if (eoptions.useThisFile) 18 | eoptions.files.push(filePath); 19 | 20 | let options: CalendarOptions = { 21 | ...CALENDAR_OPTIONS, 22 | ...this.plugin.settings.calendarOverrideOptions 23 | } 24 | 25 | if (eoptions.defaultView != null) 26 | options.initialView = eoptions.defaultView; 27 | else 28 | options.initialView = this.plugin.settings.defaultView; 29 | 30 | options.events = []; 31 | 32 | if (eoptions.events.length > 0) { 33 | const events = eoptions.events.map(str => parseListItem(str)).filter(e => e != null); 34 | console.log(events); 35 | 36 | for (const event of events) { 37 | options.events.push(event as Record); 38 | } 39 | } 40 | 41 | options.eventSources = []; 42 | 43 | if (eoptions.showGlobalEvents) { 44 | options.eventSources.push(gatherGlobalEvents); 45 | 46 | for (const source of this.plugin.externalSources) { 47 | options.eventSources.push(source); 48 | } 49 | } 50 | 51 | if (eoptions.files.length > 0) { 52 | const files = eoptions.files.map(path => app.vault.getAbstractFileByPath(path)) 53 | .filter(afile => afile instanceof TFile) 54 | .map(afile => afile as TFile); 55 | 56 | options.eventSources.push(async (..._args: any) => gatherEventsFromFiles(files, false)); 57 | } 58 | 59 | // hide header 60 | if (!eoptions.showHeader) 61 | options.headerToolbar = false; 62 | 63 | // the calendar is contained inside the wrapper so it overflows and you can scroll 64 | const wrapper = this.containerEl.createDiv({ cls: ['set-in-obsidian-wrapper', 'set-in-obsidian-wrapper-embedded'] }); 65 | 66 | let currentRange = wrapper.createEl('h4', { text: 'UNDEFINED' }); 67 | 68 | if (eoptions.headerTitle != null) 69 | currentRange.setText(eoptions.headerTitle); 70 | else if (!eoptions.showCurrentRange) 71 | currentRange.style.display = 'none'; 72 | 73 | const timeline = wrapper.createDiv({ cls: 'set-in-obsidian-timeline' }); 74 | 75 | // update the range header 76 | if (eoptions.headerTitle == null) 77 | options.datesSet = (info) => currentRange.setText(info.view.title); 78 | 79 | // NOTE: in this case user can override everything except plugins and license key 80 | this.calendar = new Calendar(timeline, { 81 | ...options, 82 | ...eoptions.fullcalendar, 83 | ...CALENDAR_OPTIONS_AFTER 84 | }); 85 | } 86 | 87 | onload() { 88 | this.calendar.render(); 89 | 90 | // TODO FIXME: cant get fullcalendar to render properly without this 91 | window.dispatchEvent(new Event('resize')); 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Set In Obsidian Plugin 2 | 3 | ``` 4 | _ _ ___ _____ ___ ____ _____ 5 | | \ | |/ _ \_ _|_ _/ ___| ____| 6 | | \| | | | || | | | | | _| 7 | | |\ | |_| || | | | |___| |___ 8 | |_| \_|\___/ |_| |___\____|_____| 9 | 10 | The project has been archived, its future is uncertain i do no not have the time or will to fix it, feel free to fork it 11 | 12 | ``` 13 | 14 | Plugin that allows time planning in obsidian 15 | 16 | > Critical content demanding immediate user attention due to potential risks. 17 | > **WARNING:** Plugin should be considered beta software until version 1.1.x is 18 | > released 19 | 20 | _Made as a simpler replacement for 21 | [obsidian-day-planner](https://github.com/lynchjames/obsidian-day-planner)_ 22 | 23 | ## Quick Usage Guide 24 | 25 | The plugin looks for date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) 26 | format inside inline code backticks at beginning of any list item, here are some 27 | examples of the syntax: 28 | 29 | ``` 30 | - `2022-12-09T14:00` all day event (14:00 to 24:00) 31 | - `2022-12-09T14:00 PT2H` event from 14:00 and lasts 2 hours 32 | - `2022-12-09 2022-12-11` event from 9th december 24:00 to 11th december 24:00 33 | ``` 34 | 35 | You can also make recurring events using 36 | [RRule](https://jakubroztocil.github.io/rrule/) _(iCalendar RFC string is coming 37 | in future versions)_ 38 | 39 | ``` 40 | - `2022-12-01 every 3 days` happens every 3 days 41 | ``` 42 | 43 | Which would show in the list view like so: 44 | ![img](screenshots/screenshot-list.png) 45 | 46 | And month view ![img](screenshots/screenshot-month.png) 47 | 48 | ### Embedding The Calendar 49 | 50 | You can embed the calendar in your notes using codeblocks with `set-in-obsidian` 51 | as the language 52 | 53 | ````markdown 54 | ```set-in-obsidian 55 | { 56 | ...optional json options... 57 | } 58 | ``` 59 | ```` 60 | 61 | **NOTE: you do not need the `{}` at all, it can be empty for default options** 62 | 63 | There are several predefined options 64 | 65 | - `set-in-obsidian` same as the calendar view 66 | - `set-in-obsidian-custom` same as calendar view but without global events, use 67 | `events` or `files` to point to files which will be read (override 68 | `set-in-obsidian-ignore`), set `useThisFile` to get events from the source 69 | file 70 | - `set-in-obsidian-minimal` minimal UI, no global calendar, blank slate 71 | basically 72 | 73 | For options available check out `EmbeddedCalendarOptions` in 74 | [src/calendar.ts](src/calendar.ts) 75 | 76 | ## Public API 77 | 78 | This plugin has public API, currently it only exposes access to 79 | [FullCallendar API](https://fullcalendar.io/docs#toc) which should allow other 80 | plugins to use the calendar too 81 | 82 | **Any function marked `@public` should be considered public API** 83 | 84 | ## Incompatible Plugins 85 | 86 | As the plugin uses [fullcalendar](https://github.com/fullcalendar/fullcalendar), 87 | other plugins using it may affect the look of the calendar depending on how they 88 | wrote the CSS _(for example 89 | [davish/obsidian-full-calendar](https://github.com/davish/obsidian-full-calendar))_ 90 | 91 | ## Installation 92 | 93 | ### Inside Obsidian 94 | 95 | You can install this plugin from within Obsidian by doing the following: 96 | 97 | - Open settings and go to `Community plugins` 98 | - Make sure `Safe mode` is **off** 99 | - Click `Browse` under `Community plugins` 100 | - Search for `Set In Obsidian` and click on it 101 | - Click `Install` 102 | - After it completes click `Enable` 103 | 104 | ### Manual 105 | 106 | - Download latest plugin archive from 107 | [here](https://github.com/sandorex/set-in-obsidian-plugin/releases/latest/download/set-in-obsidian.zip) 108 | and extract into `.obsidian/plugin/` 109 | - Enable the plugin in community plugins in settings 110 | 111 | ## Huge Thanks To 112 | 113 | - [fullcalendar developers](https://github.com/fullcalendar/fullcalendar) 114 | - Stackoverflow 115 | - Peeps at [obsidian discord](https://discord.com/invite/obsidianmd) 116 | 117 | ## Support Me 118 | 119 | If you find this plugin useful consider tipping so that my brain gives me some 120 | happy chemicals 121 | 122 | [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C7GVMY1) 123 | -------------------------------------------------------------------------------- /src/calendar.ts: -------------------------------------------------------------------------------- 1 | // sandorex/set-in-obsidian-plugin 2 | // Copyright (C) 2022 Aleksandar Radivojević 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU General Public License 15 | // along with this program. If not, see . 16 | 17 | import { CalendarOptions } from '@fullcalendar/core'; 18 | import { createDuration } from '@fullcalendar/core/internal'; 19 | import dayGridPlugin from '@fullcalendar/daygrid'; 20 | import listPlugin from '@fullcalendar/list'; 21 | import resourceTimelinePlugin from '@fullcalendar/resource-timeline'; 22 | import rrulePlugin from '@fullcalendar/rrule'; 23 | import timeGridPlugin from '@fullcalendar/timegrid'; 24 | 25 | /** 26 | * Options for FullCalendar, always applied before user provided options as defaults 27 | */ 28 | export const CALENDAR_OPTIONS: CalendarOptions = { 29 | views: { 30 | timeGridDay: { 31 | slotDuration: createDuration(30, 'minute'), 32 | } 33 | }, 34 | expandRows: true, 35 | allDaySlot: false, 36 | nowIndicator: true, 37 | headerToolbar: { 38 | left: 'today', 39 | center: 'dayGridMonth timeGridWeek,listWeek timeGridDay', 40 | right: 'prev,next' 41 | }, 42 | buttonText: { 43 | day: 'Day', 44 | month: 'Month', 45 | today: 'Today', 46 | week: 'Week', 47 | list: 'List', 48 | }, 49 | eventTimeFormat: { 50 | hour12: false, 51 | hour: '2-digit', 52 | minute: '2-digit' 53 | }, 54 | slotLabelFormat: { 55 | hour12: false, 56 | hour: '2-digit', 57 | minute: '2-digit' 58 | } 59 | }; 60 | 61 | /** 62 | * Options for FullCalendar, always applied last to ensure license and plugins are set 63 | */ 64 | export const CALENDAR_OPTIONS_AFTER: CalendarOptions = { 65 | schedulerLicenseKey: 'GPL-My-Project-Is-Open-Source', 66 | plugins: [ 67 | dayGridPlugin, 68 | listPlugin, 69 | timeGridPlugin, 70 | resourceTimelinePlugin, 71 | rrulePlugin 72 | ], 73 | } 74 | 75 | /** 76 | * Signifies different default options for FullCalendar 77 | */ 78 | export enum EmbeddedCalendarMode { 79 | DEFAULT, 80 | CUSTOM, 81 | MINIMAL, 82 | } 83 | 84 | // TODO: property to show certain date range instead of showing current date 85 | export interface EmbeddedCalendarOptions { 86 | /** 87 | * If false no date range will be shown 88 | */ 89 | showCurrentRange: boolean; 90 | 91 | /** 92 | * If false no buttons will be shown 93 | */ 94 | showHeader: boolean; 95 | 96 | /** 97 | * Show text instead of date range 98 | */ 99 | headerTitle?: string; 100 | 101 | /** 102 | * If false only `events` and events gathered from `files` will be shown 103 | */ 104 | showGlobalEvents: boolean; 105 | 106 | /** 107 | * Default view to open, if you want to embed minimal monthly calendar for example 108 | */ 109 | defaultView?: string; 110 | 111 | /** 112 | * Paths to files which should be read, ignores frontmatter ignore 113 | */ 114 | files: string[]; 115 | 116 | /** 117 | * Get events from the file where calendar is embedded 118 | */ 119 | useThisFile: boolean; 120 | 121 | /** 122 | * Events as raw string, same as task items just without the dash '-' 123 | */ 124 | events: string[]; 125 | 126 | /** 127 | * Raw options of FullCalendar `Calendar` 128 | */ 129 | fullcalendar: CalendarOptions; 130 | } 131 | 132 | export const ECALENDAR_OPTIONS_DEFAULTS: EmbeddedCalendarOptions = { 133 | showCurrentRange: true, 134 | showHeader: true, 135 | showGlobalEvents: true, 136 | useThisFile: false, 137 | files: [], 138 | events: [], 139 | fullcalendar: {}, 140 | }; 141 | 142 | export const ECALENDAR_OPTIONS_CUSTOM: EmbeddedCalendarOptions = { 143 | ...ECALENDAR_OPTIONS_DEFAULTS, 144 | showGlobalEvents: false, 145 | }; 146 | 147 | export const ECALENDAR_OPTIONS_MINIMAL: EmbeddedCalendarOptions = { 148 | ...ECALENDAR_OPTIONS_DEFAULTS, 149 | showCurrentRange: false, 150 | showHeader: false, 151 | showGlobalEvents: false, 152 | }; 153 | -------------------------------------------------------------------------------- /src/view.ts: -------------------------------------------------------------------------------- 1 | // sandorex/set-in-obsidian-plugin 2 | // Copyright (C) 2022-2023 Aleksandar Radivojević 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU General Public License 15 | // along with this program. If not, see . 16 | 17 | import { Calendar, CalendarOptions } from '@fullcalendar/core'; 18 | import { EditorPosition, EventRef, ItemView, MarkdownView, Notice, Platform, WorkspaceLeaf } from 'obsidian'; 19 | import { CALENDAR_OPTIONS, CALENDAR_OPTIONS_AFTER } from './calendar'; 20 | import SetInObsidianPlugin, { CALENDAR_VIEW_ICON, CALENDAR_VIEW_TYPE } from './main'; 21 | import { gatherGlobalEvents } from './parser'; 22 | 23 | export class CalendarView extends ItemView { 24 | private resolvedEventRef: EventRef | null; 25 | 26 | plugin: SetInObsidianPlugin; 27 | fullcalendar: Calendar | null; 28 | 29 | constructor(leaf: WorkspaceLeaf, plugin: SetInObsidianPlugin) { 30 | super(leaf); 31 | this.plugin = plugin; 32 | this.navigation = true; 33 | this.icon = CALENDAR_VIEW_ICON; 34 | } 35 | 36 | async onOpen(): Promise { 37 | this.containerEl.empty(); 38 | 39 | // the calendar is contained inside the wrapper so it overflows and you can scroll 40 | this.containerEl.createDiv({ cls: ['set-in-obsidian-wrapper', 'set-in-obsidian-wrapper-view'], }, wrapper => { 41 | const currentRange = wrapper.createEl('h4', { text: 'UNDEFINED' }); 42 | 43 | wrapper.createDiv({ cls: 'set-in-obsidian-timeline', }, elem => { 44 | let options: CalendarOptions = { 45 | ...CALENDAR_OPTIONS, 46 | ...this.plugin.settings.calendarOverrideOptions, 47 | ...CALENDAR_OPTIONS_AFTER 48 | }; 49 | 50 | options.initialView = this.plugin.settings.defaultView; 51 | 52 | // gather globla events and use external sources 53 | options.eventSources = [ 54 | gatherGlobalEvents, 55 | this.plugin.externalSources 56 | ]; 57 | 58 | // update the range header 59 | options.datesSet = (info) => currentRange.setText(info.view.title); 60 | 61 | // go to the file when clicked 62 | options.eventClick = async (arg) => { 63 | const file = arg.event.extendedProps.file; 64 | const line = arg.event.extendedProps.line; 65 | const col = arg.event.extendedProps.col; 66 | 67 | // require ctrl to open the file only on desktop 68 | if (arg.jsEvent.ctrlKey || Platform.isMobile) { 69 | const leaf = app.workspace.getLeaf('tab'); 70 | await leaf.openFile(file); 71 | 72 | const view = leaf.view as MarkdownView; 73 | view.editor.setCursor({ line: line, ch: col } as EditorPosition); 74 | view.editor.scrollIntoView({ 75 | from: { line: - 1, ch: col }, 76 | to: { line: line + 1, ch: col }, 77 | }, true); 78 | } else 79 | // TODO: try showing title on hover instead of this notice 80 | new Notice(arg.event.title); 81 | }; 82 | 83 | this.fullcalendar = new Calendar(elem, options); 84 | this.fullcalendar.render(); 85 | }); 86 | }); 87 | } 88 | 89 | async onClose(): Promise { 90 | if (this.resolvedEventRef != null) 91 | app.metadataCache.offref(this.resolvedEventRef); 92 | } 93 | 94 | private isVisible(): boolean { 95 | // i have no idea how this works but it does 96 | // source: https://stackoverflow.com/a/21696585 97 | return this.containerEl.offsetParent !== null; 98 | } 99 | 100 | onResize(): void { 101 | // force calendar to resize 102 | if (this.isVisible()) 103 | this.fullcalendar?.setOption('aspectRatio', this.fullcalendar?.getOption('aspectRatio')); 104 | 105 | // NOTE: update when files change only if the view becomes visible again 106 | if (this.isVisible() && this.resolvedEventRef == null) { 107 | this.fullcalendar?.refetchEvents(); 108 | 109 | // NOTE: does fire on renames contrary to 'changed' 110 | this.resolvedEventRef = app.metadataCache.on('resolved', () => this.fullcalendar?.refetchEvents()); 111 | } else if (!this.isVisible() && this.resolvedEventRef != null) { 112 | app.metadataCache.offref(this.resolvedEventRef); 113 | this.resolvedEventRef = null; 114 | } 115 | } 116 | 117 | getViewType(): string { 118 | return CALENDAR_VIEW_TYPE; 119 | } 120 | 121 | getDisplayText(): string { 122 | return 'SIO Calendar'; 123 | } 124 | } 125 | -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- 1 | // sandorex/set-in-obsidian-plugin 2 | // Copyright (C) 2022-2023 Aleksandar Radivojević 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU General Public License 15 | // along with this program. If not, see . 16 | 17 | import { Calendar } from '@fullcalendar/core'; 18 | import type moment from 'moment'; 19 | import { Plugin, WorkspaceLeaf } from 'obsidian'; 20 | import { EmbeddedCalendarMode } from './calendar'; 21 | import { EmbeddedCalendar } from './embedded'; 22 | import { parseEmbeddedOptions } from './parser'; 23 | import { DEFAULT_SETTINGS, SetInObsidianSettings, SetInObsidianSettingsTab } from './settings'; 24 | import { CalendarView } from './view'; 25 | 26 | declare global { 27 | interface Window { 28 | moment: typeof moment; 29 | } 30 | } 31 | 32 | export const FILE_SIZE_LIMIT = 5_000_000; // 5mb 33 | 34 | export const CALENDAR_VIEW_TYPE = 'set-in-obsidian-calendar'; 35 | export const CALENDAR_VIEW_ICON = 'calendar-clock'; 36 | 37 | export default class SetInObsidianPlugin extends Plugin { 38 | settings: SetInObsidianSettings; 39 | externalSources: any[] = []; 40 | 41 | async onload() { 42 | await this.loadSettings(); 43 | 44 | if (this.settings.devOptions) 45 | console.log('set-in-obsidian plugin developer options enabled, here be dragons'); 46 | 47 | this.registerView(CALENDAR_VIEW_TYPE, leaf => new CalendarView(leaf, this)); 48 | this.addSettingTab(new SetInObsidianSettingsTab(this.app, this)); 49 | 50 | this.addCommand({ 51 | id: 'calendar-view', 52 | name: 'Show Calendar', 53 | callback: () => this.revealCalendarView(true) 54 | }); 55 | 56 | this.addRibbonIcon(CALENDAR_VIEW_ICON, 'SIO Timeline', async () => await this.revealCalendarView()); 57 | 58 | if (this.settings.openTimelineOnStartup) 59 | this.app.workspace.onLayoutReady(() => this.revealCalendarView(false)); 60 | 61 | this.registerMarkdownCodeBlockProcessor('set-in-obsidian', (source, el, ctx) => { 62 | const result = parseEmbeddedOptions(EmbeddedCalendarMode.DEFAULT, source); 63 | if (typeof result == "string") { 64 | el.textContent = result; 65 | return; 66 | } 67 | 68 | try { 69 | ctx.addChild(new EmbeddedCalendar(el, result, ctx.sourcePath, this)); 70 | } catch (error) { 71 | el.textContent = error; 72 | } 73 | }); 74 | 75 | this.registerMarkdownCodeBlockProcessor('set-in-obsidian-custom', (source, el, ctx) => { 76 | const result = parseEmbeddedOptions(EmbeddedCalendarMode.CUSTOM, source); 77 | if (typeof result == "string") { 78 | el.textContent = result; 79 | return; 80 | } 81 | 82 | try { 83 | ctx.addChild(new EmbeddedCalendar(el, result, ctx.sourcePath, this)); 84 | } catch (error) { 85 | el.textContent = error; 86 | } 87 | }); 88 | 89 | this.registerMarkdownCodeBlockProcessor('set-in-obsidian-minimal', (source, el, ctx) => { 90 | const result = parseEmbeddedOptions(EmbeddedCalendarMode.MINIMAL, source); 91 | if (typeof result == "string") { 92 | el.textContent = result; 93 | return; 94 | } 95 | 96 | try { 97 | ctx.addChild(new EmbeddedCalendar(el, result, ctx.sourcePath, this)); 98 | } catch (error) { 99 | el.textContent = error; 100 | } 101 | }); 102 | } 103 | 104 | /** 105 | * @public 106 | * Add a FullCalendar source to global calendar 107 | */ 108 | addExternalCalendarSource(source: any) { 109 | this.externalSources.push(source); 110 | } 111 | 112 | /** 113 | * @public 114 | * Creates the timeline view if it does not exist already 115 | * @param reveal focuses the view if true 116 | */ 117 | async revealCalendarView(reveal: boolean = true) { 118 | const leaf = this.getCalendarViewLeaf(); 119 | 120 | // create it if it does not exist already 121 | if (leaf == null) 122 | await this.app.workspace.getRightLeaf(false).setViewState({ 123 | type: CALENDAR_VIEW_TYPE, 124 | active: reveal, 125 | }); 126 | else if (reveal) 127 | this.app.workspace.revealLeaf(leaf); 128 | } 129 | 130 | /** 131 | * @public 132 | * Access to FullCalendar object directly 133 | */ 134 | getCalendar(): Calendar | null | undefined { 135 | return this.getCalendarView()?.fullcalendar; 136 | } 137 | 138 | getCalendarViewLeaf(): WorkspaceLeaf | undefined { 139 | return this.app.workspace.getLeavesOfType(CALENDAR_VIEW_TYPE)[0]; 140 | } 141 | 142 | getCalendarView(): CalendarView | null { 143 | return this.getCalendarViewLeaf()?.view as CalendarView; 144 | } 145 | 146 | onunload() { 147 | this.app.workspace.detachLeavesOfType(CALENDAR_VIEW_TYPE); 148 | } 149 | 150 | async loadSettings() { 151 | this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData()); 152 | } 153 | 154 | async saveSettings() { 155 | await this.saveData(this.settings); 156 | } 157 | } 158 | -------------------------------------------------------------------------------- /src/settings.ts: -------------------------------------------------------------------------------- 1 | // sandorex/set-in-obsidian-plugin 2 | // Copyright (C) 2022-2023 Aleksandar Radivojević 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU General Public License 15 | // along with this program. If not, see . 16 | 17 | import { CalendarOptions } from '@fullcalendar/core'; 18 | import { App, Notice, PluginSettingTab, Setting } from 'obsidian'; 19 | import SetInObsidianPlugin from './main'; 20 | 21 | export interface SetInObsidianSettings { 22 | openTimelineOnStartup: boolean; 23 | useTimeline: boolean; 24 | defaultView: string; 25 | defaultEventColor: string; 26 | 27 | // dev 28 | devOptions: boolean; 29 | calendarOverrideOptions: CalendarOptions; 30 | } 31 | 32 | export const DEFAULT_SETTINGS: SetInObsidianSettings = { 33 | openTimelineOnStartup: true, 34 | useTimeline: false, 35 | defaultView: 'listWeek', 36 | defaultEventColor: '#7d5bed', 37 | 38 | // dev 39 | devOptions: false, 40 | calendarOverrideOptions: {}, 41 | } 42 | 43 | export class SetInObsidianSettingsTab extends PluginSettingTab { 44 | plugin: SetInObsidianPlugin; 45 | 46 | constructor(app: App, plugin: SetInObsidianPlugin) { 47 | super(app, plugin); 48 | this.plugin = plugin; 49 | } 50 | 51 | display(): void { 52 | const { containerEl } = this; 53 | 54 | containerEl.empty(); 55 | 56 | containerEl.createEl('h3', { 57 | attr: { 58 | style: 'text-align: center;', 59 | }, 60 | text: 'Set In Obsidian Plugin Settings' 61 | }); 62 | 63 | new Setting(containerEl) 64 | .setName('Open Timeline On Startup') 65 | .setDesc('Opens timeline on startup in background, it makes opening it faster but may lag the application a bit') 66 | .addToggle(btn => 67 | btn.setValue(this.plugin.settings.openTimelineOnStartup) 68 | .onChange(async value => { 69 | this.plugin.settings.openTimelineOnStartup = value; 70 | 71 | await this.plugin.saveSettings(); 72 | })); 73 | 74 | // new Setting(containerEl) 75 | // .setName('Horizontal Timeline') 76 | // .setDesc('Uses timeline view instead of timeGrid view') 77 | // .addToggle(btn => 78 | // btn.setValue(this.plugin.settings.useTimeline) 79 | // .onChange(async value => { 80 | // this.plugin.settings.useTimeline = value; 81 | 82 | // await this.plugin.saveSettings(); 83 | // })); 84 | 85 | // new Setting(containerEl) 86 | // .setName('Default FullCalendar View') 87 | // .setDesc('View that will be shown whenever timeline is opened') 88 | // .addDropdown(dd => { 89 | // dd.addOption('dayGridMonth', 'Month'); 90 | 91 | // if (this.plugin.settings.useTimeline) 92 | // dd.addOption('timeGridWeek', 'Week'); 93 | // else 94 | // dd.addOption('timelineWeek', 'Week'); 95 | 96 | // dd.addOption('listWeek', 'Week List'); 97 | 98 | // if (this.plugin.settings.useTimeline) 99 | // dd.addOption('timeGridDay', 'Day'); 100 | // else 101 | // dd.addOption('timelineDay', 'Day'); 102 | 103 | // dd.setValue(this.plugin.settings.defaultView); 104 | 105 | // dd.onChange(async value => { 106 | // this.plugin.settings.defaultView = value; 107 | // await this.plugin.saveSettings(); 108 | // }); 109 | // }); 110 | 111 | let eventColorSetting = new Setting(containerEl) 112 | .setName('Default Event Color'); 113 | 114 | eventColorSetting.addColorPicker(cp => { 115 | eventColorSetting.addText(text => { 116 | text.setDisabled(true); 117 | text.setValue(this.plugin.settings.defaultEventColor); 118 | cp.setValue(this.plugin.settings.defaultEventColor); 119 | 120 | cp.onChange(async value => { 121 | text.setValue(value); 122 | this.plugin.settings.defaultEventColor = value; 123 | 124 | await this.plugin.saveSettings(); 125 | }); 126 | }); 127 | }); 128 | 129 | new Setting(containerEl) 130 | .setClass('set-in-obsidian-developer-settings') 131 | .setName('Enable developer settings') 132 | .setDesc('THESE SETTINGS WILL BREAK THE ADDON IF CONFIGURED WRONGLY') 133 | .addToggle(btn => 134 | btn.setValue(this.plugin.settings.devOptions) 135 | .onChange(async value => { 136 | if (!value) { 137 | // reset all dev options after disabling 138 | this.plugin.settings.calendarOverrideOptions = DEFAULT_SETTINGS.calendarOverrideOptions; 139 | } 140 | 141 | this.plugin.settings.devOptions = value; 142 | 143 | await this.plugin.saveSettings(); 144 | 145 | // reset the screen to show the dev options 146 | this.display(); 147 | })); 148 | 149 | if (this.plugin.settings.devOptions) { 150 | containerEl.createEl('h2', { 151 | attr: { 152 | style: 'color: red; font-weight: bold' 153 | }, 154 | text: '⚠ DEVELOPER SETTINGS ⚠' 155 | }); 156 | 157 | new Setting(containerEl) 158 | .setClass('set-in-obsidian-fullcalendar-options') 159 | .setName('FullCalendar Options') 160 | .addTextArea(txt => { 161 | function setSuccess(value: boolean) { 162 | if (value) { 163 | txt.inputEl.removeClass('set-in-obsidian-fail'); 164 | txt.inputEl.addClass('set-in-obsidian-success'); 165 | } else { 166 | txt.inputEl.removeClass('set-in-obsidian-success'); 167 | txt.inputEl.addClass('set-in-obsidian-fail'); 168 | } 169 | } 170 | 171 | try { 172 | txt.setValue(JSON.stringify(this.plugin.settings.calendarOverrideOptions, null, 4)) 173 | setSuccess(true); 174 | } catch (ex) { 175 | setSuccess(false); 176 | console.error("error compiling JSON", ex); 177 | new Notice("Error compiling JSON please check the console for details"); 178 | } 179 | 180 | txt.inputEl.addEventListener('focusout', async _ev => { 181 | try { 182 | setSuccess(true); 183 | this.plugin.settings.calendarOverrideOptions = JSON.parse(txt.getValue()); 184 | await this.plugin.saveSettings(); 185 | } catch (ex) { 186 | setSuccess(false); 187 | console.error("error compiling JSON", ex); 188 | new Notice("Error compiling JSON please check the console for details"); 189 | } 190 | }); 191 | }) 192 | .setDesc('Override default options in JSON format, if you break something just delete everything and it will reset. ' 193 | + 'For more information what options are available ') 194 | .descEl.createEl('a', { 195 | text: 'click here', 196 | href: 'https://fullcalendar.io/docs/v6', 197 | }); 198 | } 199 | } 200 | } 201 | -------------------------------------------------------------------------------- /src/parser.ts: -------------------------------------------------------------------------------- 1 | // sandorex/set-in-obsidian-plugin 2 | // Copyright (C) 2022-2023 Aleksandar Radivojević 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU General Public License 15 | // along with this program. If not, see . 16 | 17 | import { CachedMetadata, ListItemCache, TFile } from 'obsidian'; 18 | import { RRule } from 'rrule'; 19 | import { ECALENDAR_OPTIONS_CUSTOM, ECALENDAR_OPTIONS_DEFAULTS, ECALENDAR_OPTIONS_MINIMAL, EmbeddedCalendarMode, EmbeddedCalendarOptions } from './calendar'; 20 | import { FILE_SIZE_LIMIT } from './main'; 21 | 22 | /** 23 | * Generator that chains two arrays together into one generator 24 | * 25 | * `array2` must be equal or larger in length than `array1` 26 | */ 27 | function* chain(array1: K[], array2: V[]): Generator<[K, V]> { 28 | for (let i = 0; i < array1.length; i++) { 29 | yield [array1[i], array2[i]]; 30 | } 31 | } 32 | 33 | async function readFilesCached(files: TFile[]): Promise> { 34 | return Promise.all(files.map(file => app.vault.cachedRead(file))).then(fileContents => 35 | new Map(chain(files, fileContents)) 36 | ); 37 | } 38 | 39 | /** 40 | * Filters files by removing files without list items, files that are too large and some special cases 41 | */ 42 | function filterMarkdownFiles(files: TFile[]): TFile[] { 43 | return files.filter(file => { 44 | // restrict file size 45 | if (file.stat.size > FILE_SIZE_LIMIT) 46 | return false; 47 | 48 | const cache = app.metadataCache.getFileCache(file); 49 | 50 | // if it does not have any list items it's useless 51 | if (cache?.listItems && cache.listItems.length <= 0) 52 | return false; 53 | 54 | // explicitly ignored files, could be useful for huge files 55 | if (cache?.frontmatter?.['set-in-obsidian-ignore'] == true) 56 | return false; 57 | 58 | // excalidraw files can be pretty huge so ignore them as well 59 | if (cache?.frontmatter?.['excalidraw-plugin'] !== undefined) 60 | return false; 61 | 62 | return true; 63 | }); 64 | } 65 | 66 | /** 67 | * Parses list item into an event 68 | * @param raw raw list item without the leading dash and brackets in case of tasks 69 | * @returns parsable event object with set title, start/end/rrule properties, or null if any errors 70 | */ 71 | export function parseListItem(raw: string): { 72 | title: string, 73 | start: Date, 74 | end?: Date, 75 | rrule?: Record 76 | } | null { 77 | const momentParse = (input: string) => window.moment(input, window.moment.ISO_8601, true); 78 | const momentParseDur = (input: string) => window.moment.duration(input); 79 | 80 | if (raw.startsWith('`')) { 81 | const index = raw.indexOf('`', 1); 82 | if (index == -1) 83 | return null; 84 | 85 | const leftover = raw.substring(index + 1).trim(); 86 | 87 | let start = null; 88 | let end = null; 89 | let rrule: RRule | null = null; 90 | 91 | const timeRaw = raw.substring(1, index); 92 | if (timeRaw.contains(' ')) { 93 | // split but keep the leftovers 94 | const timeParts = timeRaw.split(/ (.*)/s); 95 | start = momentParse(timeParts[0]); 96 | 97 | const ch = timeParts[1].at(0); 98 | if (ch == null) 99 | return null; 100 | 101 | if (ch == 'P') 102 | end = momentParseDur(timeParts[1]); 103 | else if (ch >= '0' && ch <= '9') 104 | // ISO 8601 starts with the year so assume date 105 | end = momentParse(timeParts[1]); 106 | else { 107 | // otherwise try getting rrule 108 | try { 109 | rrule = RRule.fromText(timeParts[1]); 110 | } catch (err) { 111 | // TODO: debugging mode and more information for catching errors 112 | return null; 113 | } 114 | 115 | // TODO: remove this when event highlighting is added and let user decide if its right 116 | // check if read properly, as it gives some weird results otherwise 117 | if (timeParts[1] != rrule.toText()) 118 | return null; 119 | } 120 | } else 121 | start = momentParse(timeRaw); 122 | 123 | if (start == null) 124 | return null; 125 | 126 | if (rrule != null) { 127 | return { 128 | title: leftover, 129 | start: start.toDate(), 130 | rrule: { 131 | ...rrule.options, 132 | 133 | // set the starting date for recurrance 134 | dtstart: start.toDate(), 135 | }, 136 | } 137 | } 138 | 139 | if (end == null) 140 | return { 141 | title: leftover, 142 | start: start.toDate(), 143 | end: start.clone().set('hours', 24).set('minutes', 0).set('seconds', 0).toDate(), 144 | } 145 | 146 | if (window.moment.isDuration(end)) 147 | return { 148 | title: leftover, 149 | start: start.toDate(), 150 | end: start.clone().add(end).toDate(), 151 | } 152 | 153 | // making it inclusive of the end date 154 | if (end.hours() + end.minutes() + end.seconds() == 0) 155 | end.set('hours', 24); 156 | 157 | return { 158 | title: leftover, 159 | start: start.toDate(), 160 | end: end.toDate(), 161 | } 162 | } 163 | 164 | return null; 165 | } 166 | 167 | async function extractListItems(files: TFile[]): Promise<{ 168 | file: TFile, 169 | fileCache: CachedMetadata, 170 | listItems: [ListItemCache, string][], 171 | }[]> { 172 | const fileContents = await readFilesCached(files); 173 | 174 | let items: any[] = []; 175 | 176 | // extract each item as string 177 | fileContents.forEach((contents, file) => { 178 | const cache = app.metadataCache.getFileCache(file); 179 | 180 | if (cache == null || cache.listItems == null || cache.listItems.length == 0) 181 | return; 182 | 183 | items.push({ 184 | file: file, 185 | fileCache: cache, 186 | listItems: cache.listItems.map(item => { 187 | // all list items start with '- ' 188 | let offset = 2; 189 | 190 | // remove the '[ ] ' from the task, you can use cache task property to check type 191 | if (item.task != null) 192 | offset += 4; 193 | 194 | return [ 195 | item, 196 | contents.substring(item.position.start.offset + offset, item.position.end.offset).trim() 197 | ]; 198 | }), 199 | }); 200 | }); 201 | 202 | return items; 203 | } 204 | 205 | export async function gatherEventsFromFiles(files: TFile[], filter = true): Promise[]> { 206 | const listItemFiles = await extractListItems(filter ? filterMarkdownFiles(files) : files); 207 | 208 | let events: Record[] = []; 209 | 210 | for (const file of listItemFiles) { 211 | for (const [metadata, rawText] of file.listItems) { 212 | const results = parseListItem(rawText); 213 | 214 | if (results == null) 215 | continue; 216 | 217 | // TODO: color done tasks, but only border or text so that rrule tasks can be different 218 | 219 | const event: Record = { 220 | ...results, 221 | 222 | // NOTE: these are used to open the file where the event was found 223 | extendedProps: { 224 | file: file.file, 225 | line: metadata.position.start.line, 226 | col: metadata.position.start.col 227 | } 228 | }; 229 | 230 | if (event.rrule != null) 231 | event.color = '#eb8d1a'; // TODO: set the colors in options 232 | 233 | if (file.fileCache.frontmatter?.['set-in-obsidian-color'] != null) 234 | event.color = file.fileCache.frontmatter['set-in-obsidian-color']; 235 | 236 | events.push(event); 237 | } 238 | } 239 | 240 | return events; 241 | } 242 | 243 | /** 244 | * Gathers all global events, filtered 245 | */ 246 | export async function gatherGlobalEvents(..._args: any): Promise[]> { 247 | return gatherEventsFromFiles(app.vault.getMarkdownFiles(), true); 248 | } 249 | 250 | /** 251 | * Parses JSON embedded options and sets defaults depending on the mode, returns a string on error 252 | */ 253 | export function parseEmbeddedOptions(mode: EmbeddedCalendarMode, str: string): EmbeddedCalendarOptions | string { 254 | let data: Record; 255 | 256 | switch (mode) { 257 | case EmbeddedCalendarMode.CUSTOM: 258 | data = ECALENDAR_OPTIONS_CUSTOM; 259 | break; 260 | 261 | case EmbeddedCalendarMode.MINIMAL: 262 | data = ECALENDAR_OPTIONS_MINIMAL; 263 | break; 264 | 265 | default: 266 | data = ECALENDAR_OPTIONS_DEFAULTS; 267 | break; 268 | } 269 | 270 | // if empty use default options 271 | if (str.trim() == "") 272 | return data as EmbeddedCalendarOptions; 273 | 274 | try { 275 | data = { 276 | ...data, 277 | ...JSON.parse(str) 278 | }; 279 | } catch (error) { 280 | return `Error parsing options: ${error}`; 281 | } 282 | 283 | return data as EmbeddedCalendarOptions; 284 | } 285 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------