├── .npmrc ├── versions.json ├── .prettierrc ├── .eslintignore ├── src ├── settings │ ├── plugin-settings.ts │ └── settings-tab.ts ├── react-components │ ├── ReplaceAllButton.tsx │ ├── ResultsNumberSummary.tsx │ ├── use-open-selection-in-editor.ts │ ├── use-scroll-selected-search-result-into-view.ts │ ├── ReplaceInput.tsx │ ├── PromptInstructions.tsx │ ├── use-bind-obsidian-event-handlers.ts │ ├── use-replace-selection.ts │ ├── SearchInput.tsx │ ├── EnableRegexButton.tsx │ ├── EnableCaseSensitivityButton.tsx │ ├── SearchResultDisplay.tsx │ ├── use-search.ts │ ├── SearchResultsContainer.tsx │ └── SearchAndReplace.tsx ├── infrastructure │ └── event-bridge.ts ├── util │ └── utils.ts ├── domain │ ├── search-result.ts │ └── file-operator.ts ├── main.ts └── obsidian-components │ └── search-and-replace-modal.tsx ├── .editorconfig ├── manifest.json ├── .gitignore ├── tsconfig.json ├── version-bump.mjs ├── .eslintrc ├── esbuild.config.mjs ├── package.json ├── styles.css ├── README.md ├── .github └── workflows │ └── release.yml └── LICENSE /.npmrc: -------------------------------------------------------------------------------- 1 | tag-version-prefix="" -------------------------------------------------------------------------------- /versions.json: -------------------------------------------------------------------------------- 1 | { 2 | "1.0.0": "0.15.0" 3 | } 4 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "printWidth": 100, 3 | "arrowParens": "avoid" 4 | } 5 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | node_modules/obsidian-plugins/ 3 | main.js 4 | obsidian-plugins/ 5 | -------------------------------------------------------------------------------- /src/settings/plugin-settings.ts: -------------------------------------------------------------------------------- 1 | export interface PluginSettings { 2 | replaceAllEnabled: boolean; 3 | } 4 | -------------------------------------------------------------------------------- /src/react-components/ReplaceAllButton.tsx: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | 3 | export function ReplaceAllButton() { 4 | return ; 5 | } 6 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "global-search-and-replace", 3 | "name": "Global Search and Replace", 4 | "version": "0.5.0", 5 | "minAppVersion": "1.1.1", 6 | "description": "Search and replace in all vault files", 7 | "author": "Mahmoud Fawzy Khalil", 8 | "authorUrl": "https://github.com/MahmoudFawzyKhalil/", 9 | "isDesktopOnly": false 10 | } 11 | -------------------------------------------------------------------------------- /src/infrastructure/event-bridge.ts: -------------------------------------------------------------------------------- 1 | import { KeymapEventListener } from "obsidian"; 2 | 3 | export class EventBridge { 4 | onArrowUp?: KeymapEventListener; 5 | onArrowDown?: KeymapEventListener; 6 | onEnter?: KeymapEventListener; 7 | onCommandEnter?: KeymapEventListener; 8 | } 9 | 10 | const eventBridge = new EventBridge(); 11 | export default eventBridge; 12 | -------------------------------------------------------------------------------- /src/util/utils.ts: -------------------------------------------------------------------------------- 1 | export function isBlank(str: string): boolean { 2 | return !str || /^\s*$/.test(str); 3 | } 4 | 5 | export function findLastIndex( 6 | array: Array, 7 | predicate: (value: T, index: number, obj: T[]) => boolean 8 | ): number { 9 | let l = array.length; 10 | while (l--) { 11 | if (predicate(array[l], l, array)) return l; 12 | } 13 | return -1; 14 | } 15 | -------------------------------------------------------------------------------- /.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 | /obsidian-plugins/ 24 | /obsidian-plugin-downloader.sh 25 | -------------------------------------------------------------------------------- /src/react-components/ResultsNumberSummary.tsx: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | 3 | interface ResultsNumberSummaryProps { 4 | numberOfResults: number; 5 | numberOfFilesWithMatches: number; 6 | } 7 | export function ResultsNumberSummary({ 8 | numberOfResults, 9 | numberOfFilesWithMatches, 10 | }: ResultsNumberSummaryProps) { 11 | return ( 12 |
13 | {numberOfResults} matches found in {numberOfFilesWithMatches} files 14 |
15 | ); 16 | } 17 | -------------------------------------------------------------------------------- /src/react-components/use-open-selection-in-editor.ts: -------------------------------------------------------------------------------- 1 | import { FileOperator } from "../domain/file-operator"; 2 | import { useCallback } from "react"; 3 | import { SearchAndReplaceState } from "./SearchAndReplace"; 4 | 5 | export function useOpenSelectionInEditor(fileOperator: FileOperator, state: SearchAndReplaceState) { 6 | return useCallback(async () => { 7 | await fileOperator.open(state.searchResults[state.selectedIndex]); 8 | }, [fileOperator, state.searchResults, state.selectedIndex]); 9 | } 10 | -------------------------------------------------------------------------------- /src/react-components/use-scroll-selected-search-result-into-view.ts: -------------------------------------------------------------------------------- 1 | import { useEffect } from "react"; 2 | 3 | export function useScrollSelectedSearchResultIntoView(selectedSearchResultIndex: number) { 4 | useEffect(() => { 5 | scrollIntoView(selectedSearchResultIndex); 6 | }, [selectedSearchResultIndex]); 7 | } 8 | 9 | function scrollIntoView(selectedIndex: number) { 10 | const searchResultElement = document.querySelector( 11 | `[data-search-result-index="${selectedIndex}"]` 12 | ); 13 | searchResultElement?.scrollIntoView({ behavior: "auto", block: "nearest" }); 14 | } 15 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": ".", 4 | "inlineSourceMap": true, 5 | "inlineSources": true, 6 | "module": "ESNext", 7 | "target": "ES2022", 8 | "allowJs": true, 9 | "noImplicitAny": true, 10 | "moduleResolution": "node", 11 | "importHelpers": true, 12 | "isolatedModules": true, 13 | "strictNullChecks": true, 14 | "jsx": "react", 15 | "strict": true, 16 | "lib": [ 17 | "DOM", 18 | "ES2021" 19 | ] 20 | }, 21 | "include": [ 22 | "**/*.ts", 23 | "**/*.tsx" 24 | ], 25 | "exclude": [ 26 | "obsidian-plugins" 27 | ] 28 | } 29 | -------------------------------------------------------------------------------- /src/react-components/ReplaceInput.tsx: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | 3 | interface ReplaceInputProps { 4 | value: string; 5 | onChange: React.ChangeEventHandler; 6 | } 7 | 8 | export function ReplaceInput({ value, onChange }: ReplaceInputProps) { 9 | return ( 10 |
11 | 19 | {/* TODO */} 20 |
21 | ); 22 | } 23 | -------------------------------------------------------------------------------- /src/react-components/PromptInstructions.tsx: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | 3 | export function PromptInstructions(): JSX.Element { 4 | return ( 5 |
6 |
7 | ↑↓ 8 | to navigate 9 |
10 |
11 | ↵ 12 | to replace 13 |
14 |
15 | ⌘↵ 16 | to open 17 |
18 |
19 | ); 20 | } 21 | -------------------------------------------------------------------------------- /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": { 5 | "node": true 6 | }, 7 | "plugins": [ 8 | "@typescript-eslint" 9 | ], 10 | "extends": [ 11 | "eslint:recommended", 12 | "plugin:@typescript-eslint/eslint-recommended", 13 | "plugin:@typescript-eslint/recommended", 14 | "plugin:react/recommended", 15 | "plugin:react-hooks/recommended" 16 | ], 17 | "parserOptions": { 18 | "sourceType": "module" 19 | }, 20 | "rules": { 21 | "indent": "off", 22 | "no-mixed-spaces-and-tabs": "off", 23 | "no-unused-vars": "off", 24 | "@typescript-eslint/no-unused-vars": [ 25 | "error", 26 | { 27 | "args": "none" 28 | } 29 | ], 30 | "@typescript-eslint/ban-ts-comment": "off", 31 | "no-prototype-builtins": "off", 32 | "@typescript-eslint/no-empty-function": "off" 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/react-components/use-bind-obsidian-event-handlers.ts: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | import { useEffect } from "react"; 3 | import eventBridge from "../infrastructure/event-bridge"; 4 | import { SearchAndReplaceAction } from "./SearchAndReplace"; 5 | 6 | export function useBindObsidianEventHandlers( 7 | dispatch: React.Dispatch, 8 | replaceSelection: () => Promise, 9 | openSelectionInEditor: () => Promise 10 | ) { 11 | // Bind event handlers to events coming from Obsidian 12 | useEffect(() => { 13 | eventBridge.onArrowUp = () => dispatch({ type: "move_selection_up" }); 14 | eventBridge.onArrowDown = () => dispatch({ type: "move_selection_down" }); 15 | eventBridge.onEnter = replaceSelection; 16 | eventBridge.onCommandEnter = openSelectionInEditor; 17 | }, [replaceSelection, openSelectionInEditor, dispatch]); 18 | } 19 | -------------------------------------------------------------------------------- /src/settings/settings-tab.ts: -------------------------------------------------------------------------------- 1 | import { App, PluginSettingTab, Setting } from "obsidian"; 2 | import SearchAndReplacePlugin, { DEFAULT_SETTINGS } from "../main"; 3 | 4 | export class SettingsTab extends PluginSettingTab { 5 | plugin: SearchAndReplacePlugin; 6 | 7 | constructor(app: App, plugin: SearchAndReplacePlugin) { 8 | super(app, plugin); 9 | this.plugin = plugin; 10 | } 11 | 12 | display(): void { 13 | this.containerEl.empty(); 14 | 15 | this.containerEl.createEl("h2", { 16 | text: "Search and Replace", 17 | }); 18 | 19 | const settings = this.plugin.settings || DEFAULT_SETTINGS; 20 | 21 | new Setting(this.containerEl) 22 | .setName("Replace all") 23 | .setDesc( 24 | "⚠️ Enable replace all (Please back up your vault! There is no undo!)" 25 | ) 26 | .addToggle((b) => 27 | b.setValue(settings.replaceAllEnabled).onChange(async (v) => { 28 | settings.replaceAllEnabled = v; 29 | await this.plugin.saveSettings(); 30 | }) 31 | ); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/domain/search-result.ts: -------------------------------------------------------------------------------- 1 | import { TFile } from "obsidian"; 2 | 3 | export class SearchResult { 4 | line: string; 5 | matchStartIndex: number; 6 | matchEndIndex: number; 7 | filePath: string; 8 | lineNumber: number; 9 | 10 | file?: TFile; 11 | 12 | public constructor( 13 | line: string, 14 | lineNumber: number, 15 | filePath: string, 16 | matchStartIndex: number, 17 | matchEndIndex: number, 18 | file?: TFile 19 | ) { 20 | this.line = line; 21 | this.matchStartIndex = matchStartIndex; 22 | this.matchEndIndex = matchEndIndex; 23 | this.filePath = filePath; 24 | this.lineNumber = lineNumber; 25 | this.file = file; 26 | } 27 | 28 | public getBeforeMatchSubstring(): string { 29 | return this.line.substring(0, this.matchStartIndex); 30 | } 31 | 32 | public getMatchSubstring(): string { 33 | return this.line.substring( 34 | this.matchStartIndex, 35 | this.matchEndIndex + 1 36 | ); 37 | } 38 | 39 | getAfterMatchSubstring(): string { 40 | return this.line.substring(this.matchEndIndex + 1); 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /src/react-components/use-replace-selection.ts: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | import { useCallback } from "react"; 3 | import { FileOperator } from "../domain/file-operator"; 4 | import { SearchAndReplaceAction, SearchAndReplaceState } from "./SearchAndReplace"; 5 | 6 | export function useReplaceSelection( 7 | state: SearchAndReplaceState, 8 | dispatch: React.Dispatch, 9 | fileOperator: FileOperator 10 | ) { 11 | return useCallback(async () => { 12 | if (state.searchResults.length === 0) return; 13 | 14 | const replaceOperationResult = await fileOperator.replace( 15 | state.searchResults[state.selectedIndex], 16 | state.replacementText, 17 | state.searchQuery, 18 | state.regexEnabled, 19 | state.caseSensitivityEnabled 20 | ); 21 | 22 | dispatch({ type: "replace", replaceOperationResult }); 23 | }, [ 24 | dispatch, 25 | fileOperator, 26 | state.caseSensitivityEnabled, 27 | state.regexEnabled, 28 | state.replacementText, 29 | state.searchQuery, 30 | state.searchResults, 31 | state.selectedIndex, 32 | ]); 33 | } 34 | -------------------------------------------------------------------------------- /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 | const context = await esbuild.context({ 15 | banner: { 16 | js: banner, 17 | }, 18 | entryPoints: ["src/main.ts"], 19 | bundle: true, 20 | external: [ 21 | "obsidian", 22 | "electron", 23 | "@codemirror/autocomplete", 24 | "@codemirror/collab", 25 | "@codemirror/commands", 26 | "@codemirror/language", 27 | "@codemirror/lint", 28 | "@codemirror/search", 29 | "@codemirror/state", 30 | "@codemirror/view", 31 | "@lezer/common", 32 | "@lezer/highlight", 33 | "@lezer/lr", 34 | ...builtins], 35 | format: "cjs", 36 | target: "es2018", 37 | logLevel: "info", 38 | sourcemap: prod ? false : "inline", 39 | treeShaking: true, 40 | outfile: "main.js", 41 | }); 42 | 43 | if (prod) { 44 | await context.rebuild(); 45 | process.exit(0); 46 | } else { 47 | await context.watch(); 48 | } 49 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "obsidian-search-and-replace", 3 | "version": "0.5.0", 4 | "description": "Global search and replace for obsidian.md", 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 manifest.json versions.json" 10 | }, 11 | "keywords": [], 12 | "author": { 13 | "name": "Mahmoud Fawzy Khalil", 14 | "url": "https://github.com/MahmoudFawzyKhalil/", 15 | "email": "mahmoudfawzykhalil98@gmail.com" 16 | }, 17 | "license": "MIT", 18 | "devDependencies": { 19 | "@types/node": "18.14.0", 20 | "@types/react": "18.0.28", 21 | "@types/react-dom": "18.0.11", 22 | "@typescript-eslint/eslint-plugin": "5.29.0", 23 | "@typescript-eslint/parser": "5.29.0", 24 | "builtin-modules": "3.3.0", 25 | "esbuild": "0.17.3", 26 | "eslint": "8.34.0", 27 | "eslint-plugin-react": "7.32.2", 28 | "eslint-plugin-react-hooks": "4.6.0", 29 | "obsidian": "1.1.1", 30 | "prettier": "2.8.4", 31 | "tslib": "2.4.0", 32 | "typescript": "4.7.4" 33 | }, 34 | "dependencies": { 35 | "react": "18.2.0", 36 | "react-dom": "18.2.0" 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /src/react-components/SearchInput.tsx: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | import { EnableRegexButton, EnableRegexButtonProps } from "./EnableRegexButton"; 3 | import { 4 | EnableCaseSensitivityButton, 5 | EnableCaseSensitivityButtonProps, 6 | } from "./EnableCaseSensitivityButton"; 7 | 8 | interface SearchInputProps extends EnableRegexButtonProps, EnableCaseSensitivityButtonProps { 9 | value: string; 10 | onChange: React.ChangeEventHandler; 11 | } 12 | 13 | export default function SearchInput({ 14 | value, 15 | onChange, 16 | regexEnabled, 17 | onToggleRegexSearch, 18 | onToggleCaseSensitiveSearch, 19 | caseSensitivityEnabled, 20 | }: SearchInputProps) { 21 | return ( 22 |
23 | 32 | 36 | 40 |
41 | ); 42 | } 43 | -------------------------------------------------------------------------------- /src/react-components/EnableRegexButton.tsx: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | 3 | export interface EnableRegexButtonProps { 4 | regexEnabled: boolean; 5 | onToggleRegexSearch: React.MouseEventHandler; 6 | } 7 | 8 | export function EnableRegexButton({ 9 | regexEnabled, 10 | onToggleRegexSearch, 11 | }: EnableRegexButtonProps) { 12 | return ( 13 |
18 |
24 |
25 | 37 | 38 | 39 | 40 | 41 | 42 |
43 |
44 |
45 | ); 46 | } 47 | -------------------------------------------------------------------------------- /src/react-components/EnableCaseSensitivityButton.tsx: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | 3 | export interface EnableCaseSensitivityButtonProps { 4 | caseSensitivityEnabled: boolean; 5 | onToggleCaseSensitiveSearch: React.MouseEventHandler; 6 | } 7 | 8 | export function EnableCaseSensitivityButton({ 9 | caseSensitivityEnabled, 10 | onToggleCaseSensitiveSearch, 11 | }: EnableCaseSensitivityButtonProps) { 12 | return ( 13 |
18 |
26 |
27 | 39 | 40 | 41 | 42 | 43 | 44 |
45 |
46 |
47 | ); 48 | } 49 | -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- 1 | import { App, Plugin, PluginManifest } from "obsidian"; 2 | import { PluginSettings } from "./settings/plugin-settings"; 3 | import { SearchAndReplaceModal } from "./obsidian-components/search-and-replace-modal"; 4 | import { FileOperator } from "./domain/file-operator"; 5 | 6 | export const DEFAULT_SETTINGS: PluginSettings = { 7 | replaceAllEnabled: false, 8 | }; 9 | 10 | export default class SearchAndReplacePlugin extends Plugin { 11 | settings: PluginSettings | undefined; 12 | private fileOperator: FileOperator; 13 | 14 | constructor(app: App, manifest: PluginManifest) { 15 | super(app, manifest); 16 | this.fileOperator = new FileOperator(app); 17 | } 18 | 19 | async onload() { 20 | await this.loadSettings(); 21 | this.addPluginCommand(); 22 | 23 | // TODO there are no settings yet 24 | // this.addSettingTab(new SettingsTab(this.app, this)); 25 | } 26 | 27 | private addPluginCommand(): void { 28 | this.addCommand({ 29 | id: "search-and-replace", 30 | name: "Search and Replace in all files", 31 | callback: () => { 32 | new SearchAndReplaceModal(this.app, this.fileOperator).open(); 33 | }, 34 | }); 35 | } 36 | 37 | onunload() { 38 | // Nothing to unload yet 39 | } 40 | 41 | async loadSettings() { 42 | this.settings = Object.assign( 43 | {}, 44 | DEFAULT_SETTINGS, 45 | await this.loadData() 46 | ); 47 | } 48 | 49 | async saveSettings() { 50 | await this.saveData(this.settings); 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /src/react-components/SearchResultDisplay.tsx: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | import { PropsWithChildren } from "react"; 3 | import { SearchResult } from "../domain/search-result"; 4 | import { SearchResultChosenHandler, SelectedIndexChangedHandler } from "./SearchResultsContainer"; 5 | 6 | interface SearchResultDisplayProps extends PropsWithChildren { 7 | isSelected: boolean; 8 | searchResult: SearchResult; 9 | index: number; 10 | onSelectedIndexChanged: SelectedIndexChangedHandler; 11 | onSearchResultChosen: SearchResultChosenHandler; 12 | } 13 | 14 | export default function SearchResultDisplay({ 15 | isSelected, 16 | searchResult, 17 | index, 18 | onSelectedIndexChanged, 19 | onSearchResultChosen, 20 | }: SearchResultDisplayProps) { 21 | return ( 22 |
onSelectedIndexChanged(index)} 24 | onPointerDown={() => onSelectedIndexChanged(index)} 25 | onPointerUp={onSearchResultChosen} 26 | data-search-result-index={index} 27 | className={`suggestion-item mod-complex ${isSelected ? "is-selected" : ""}`} 28 | > 29 |
30 |
31 | {searchResult.getBeforeMatchSubstring()} 32 | {searchResult.getMatchSubstring()} 33 | {searchResult.getAfterMatchSubstring()} 34 |
35 |
36 |
37 | 38 | {searchResult.filePath} 39 | 40 | {searchResult.lineNumber} 41 |
42 |
43 | ); 44 | } 45 | -------------------------------------------------------------------------------- /styles.css: -------------------------------------------------------------------------------- 1 | .snr-line-number { 2 | font-size: var(--font-ui-small); 3 | } 4 | 5 | .snr-suggestion-content { 6 | /* Nothing */ 7 | } 8 | 9 | .snr-suggestion-flair { 10 | word-break: break-word; 11 | } 12 | 13 | .snr-suggestion-aux { 14 | max-width: 40%; 15 | } 16 | 17 | .snr-highlight { 18 | color: var(--text-normal); 19 | background-color: var(--text-highlight-bg); 20 | } 21 | 22 | .snr-input-button-wrapper { 23 | /*margin-top: var(--size-4-2);*/ 24 | /*margin-bottom: var(--size-4-2);*/ 25 | display: flex; 26 | justify-content: space-between; 27 | align-items: center; 28 | gap: var(--size-4-4); 29 | border-bottom: 1px solid var(--background-secondary); 30 | } 31 | 32 | .snr-input-button-wrapper > button { 33 | margin-right: var(--size-4-4); 34 | } 35 | 36 | 37 | .is-phone .snr-input-button-wrapper > button { 38 | margin-right: var(--size-4-4); 39 | width: unset; 40 | } 41 | 42 | .is-tablet .snr-input-button-wrapper > button { 43 | margin-right: var(--size-4-4); 44 | } 45 | 46 | .snr-input-icon-wrapper { 47 | display: flex; 48 | justify-content: space-between; 49 | align-items: center; 50 | border-bottom: 1px solid var(--background-secondary); 51 | } 52 | 53 | .snr-regex-button { 54 | margin-right: var(--size-4-4); 55 | } 56 | 57 | .snr-workspace-tab-header-inner { 58 | padding: var(--size-4-2); 59 | } 60 | 61 | .snr-workspace-tab-header-inner-icon-active { 62 | background-color: var(--background-modifier-form-field); 63 | } 64 | 65 | .snr-result-summary { 66 | border-top: 1px solid var(--background-secondary); 67 | user-select: none; 68 | font-size: var(--font-ui-smaller); 69 | color: var(--text-muted); 70 | padding: var(--size-4-2); 71 | display: flex; 72 | text-align: center; 73 | justify-content: center; 74 | } 75 | -------------------------------------------------------------------------------- /src/react-components/use-search.ts: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | import { useCallback, useEffect, useMemo } from "react"; 3 | import { FileOperator } from "../domain/file-operator"; 4 | import { debounce } from "obsidian"; 5 | import { SearchAndReplaceAction, SearchAndReplaceState } from "./SearchAndReplace"; 6 | import { isBlank } from "../util/utils"; 7 | 8 | export function useSearch( 9 | state: SearchAndReplaceState, 10 | dispatch: React.Dispatch, 11 | fileOperator: FileOperator 12 | ) { 13 | const search = useCallback( 14 | async (query: string, withRegex: boolean, withCaseSensitivity: boolean) => { 15 | const { searchResults, numberOfFilesWithMatches } = await fileOperator.search( 16 | query, 17 | withRegex, 18 | withCaseSensitivity 19 | ); 20 | 21 | dispatch({ 22 | type: "search", 23 | payload: { 24 | nextNumberOfFilesWithMatches: numberOfFilesWithMatches, 25 | nextSearchResults: searchResults, 26 | }, 27 | }); 28 | }, 29 | [dispatch, fileOperator] 30 | ); 31 | 32 | // useMemo instead of useCallback because the function is not inline 33 | // https://kyleshevlin.com/debounce-and-throttle-callbacks-with-react-hooks 34 | const debouncedSearch = useMemo( 35 | () => 36 | debounce( 37 | (query: string, withRegex: boolean, withCaseSensitivity: boolean) => 38 | search(query, withRegex, withCaseSensitivity), 39 | 300, 40 | true 41 | ), 42 | [search] 43 | ); 44 | 45 | useEffect(() => { 46 | if (isBlank(state.searchQuery)) { 47 | dispatch({ type: "clear" }); 48 | return; 49 | } 50 | debouncedSearch(state.searchQuery, state.regexEnabled, state.caseSensitivityEnabled); 51 | }, [ 52 | state.searchQuery, 53 | state.regexEnabled, 54 | state.caseSensitivityEnabled, 55 | debouncedSearch, 56 | dispatch, 57 | ]); 58 | } 59 | -------------------------------------------------------------------------------- /src/obsidian-components/search-and-replace-modal.tsx: -------------------------------------------------------------------------------- 1 | import {App, Modal} from "obsidian"; 2 | import {createRoot, Root} from "react-dom/client"; 3 | import * as React from "react"; 4 | import SearchAndReplace from "../react-components/SearchAndReplace"; 5 | import eventBridge from "../infrastructure/event-bridge"; 6 | import {FileOperator} from "../domain/file-operator"; 7 | 8 | export class SearchAndReplaceModal extends Modal { 9 | private readonly reactRoot: Root; 10 | private readonly fileOperator: FileOperator; 11 | 12 | constructor(app: App, fileOperator: FileOperator) { 13 | super(app); 14 | this.prepareModalEl(); 15 | this.reactRoot = createRoot(this.modalEl); 16 | this.registerEventListeners(); 17 | this.fileOperator = fileOperator; 18 | } 19 | 20 | private prepareModalEl() { 21 | this.modalEl.replaceChildren(); 22 | this.modalEl.addClass("prompt"); 23 | this.modalEl.removeClass("modal"); 24 | } 25 | 26 | private registerEventListeners() { 27 | // Move selection to previous note 28 | this.scope.register([], "ArrowUp", (e, ctx) => { 29 | e.preventDefault(); 30 | eventBridge.onArrowUp?.(e, ctx); 31 | }); 32 | 33 | // Move selection to next note 34 | this.scope.register([], "ArrowDown", (e, ctx) => { 35 | e.preventDefault(); 36 | eventBridge.onArrowDown?.(e, ctx); 37 | }); 38 | 39 | // Replace note at selectedIndex 40 | this.scope.register([], "Enter", (e, ctx) => { 41 | e.preventDefault(); 42 | 43 | // Prevent press and hold 44 | if (e.repeat) return; 45 | 46 | eventBridge.onEnter?.(e, ctx); 47 | }); 48 | 49 | // Open note at selectedIndex 50 | this.scope.register(["Mod"], "Enter", (e, ctx) => { 51 | e.preventDefault(); 52 | 53 | // Prevent press and hold 54 | if (e.repeat) return; 55 | 56 | eventBridge.onCommandEnter?.(e, ctx); 57 | this.close(); 58 | }); 59 | } 60 | 61 | onOpen() { 62 | this.reactRoot.render( 63 | 64 | ); 65 | } 66 | 67 | onClose() { 68 | this.reactRoot.unmount(); 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /src/react-components/SearchResultsContainer.tsx: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | import { SearchResult } from "../domain/search-result"; 3 | import SearchResultDisplay from "./SearchResultDisplay"; 4 | 5 | interface SearchResultsContainerProps { 6 | searchResults: SearchResult[]; 7 | selectedIndex: number; 8 | numberOfResultsToDisplay: number; 9 | onScrollThresholdExceeded: () => void; 10 | onSelectedIndexChanged: SelectedIndexChangedHandler; 11 | onSearchResultChosen: SearchResultChosenHandler; 12 | } 13 | 14 | export type SelectedIndexChangedHandler = (newIndex: number) => void; 15 | export type SearchResultChosenHandler = () => Promise; 16 | 17 | function createKey(searchResult: SearchResult) { 18 | return ( 19 | searchResult.line + 20 | searchResult.matchStartIndex + 21 | searchResult.filePath + 22 | searchResult.lineNumber 23 | ); 24 | } 25 | 26 | function SearchResultsContainer({ 27 | searchResults, 28 | selectedIndex, 29 | numberOfResultsToDisplay, 30 | onSelectedIndexChanged, 31 | onScrollThresholdExceeded, 32 | onSearchResultChosen, 33 | }: SearchResultsContainerProps) { 34 | const resultsMarkup = searchResults.map((searchResult, index) => { 35 | const key = createKey(searchResult); 36 | 37 | if (index >= numberOfResultsToDisplay) return null; 38 | 39 | return ( 40 | 48 | ); 49 | }); 50 | 51 | function handleScroll(event: React.UIEvent) { 52 | const promptResultsDiv = event.target as HTMLDivElement; 53 | 54 | const elementTotalHeightWithOverflow = promptResultsDiv.scrollHeight; 55 | 56 | const elementActualHeight = promptResultsDiv.offsetHeight; 57 | const scrollOffsetFromTop = promptResultsDiv.scrollTop; 58 | 59 | const scrollPercentage = 60 | (scrollOffsetFromTop + elementActualHeight) / elementTotalHeightWithOverflow; 61 | 62 | if (scrollPercentage >= 0.95) { 63 | onScrollThresholdExceeded(); 64 | } 65 | } 66 | 67 | return ( 68 |
69 | {resultsMarkup} 70 |
71 | ); 72 | } 73 | 74 | export default React.memo(SearchResultsContainer); 75 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Global Search and Replace for Obsidian 2 | 3 | 4 | ![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?logo=obsidian&color=%23483699&label=downloads&query=%24%5B%22global-search-and-replace%22%5D.downloads&url=https%3A%2F%2Fraw.githubusercontent.com%2Fobsidianmd%2Fobsidian-releases%2Fmaster%2Fcommunity-plugin-stats.json) 5 | ![Version](https://img.shields.io/github/v/release/MahmoudFawzyKhalil/obsidian-global-search-and-replace?include_prereleases&color=blue) 6 | 7 | > A plugin to do a global search and replace in all of your Obsidian vault files. 8 | 9 | ![showcase](https://user-images.githubusercontent.com/73137611/222190446-27b043f2-455b-4a97-a184-5d17f4e4c901.gif) 10 | 11 | ## Features 12 | 13 | - Search all of your vault's markdown files for a match 14 | - Regex support 15 | - Case-sensitive search support 16 | - Replace match `Enter` or `click` 17 | - Open note at match `Ctrl+Enter` on Windows/Linux, `Cmd+Enter` on Mac 18 | - Cycle through matches using arrow keys 19 | 20 | ## Installation 21 | 22 | ### Through Obsidian community plugin browser 23 | This plugin is available through obsidian's official plugin marketplace. 24 | 25 | ### Manual 26 | Download a release's `main.js`, `styles.css`, and `manifest.json` files and install it by pasting the files into the `VAULT_PATH/.obsidian/plugins/global-search-and-replace` folder (enable viewing hidden folders to be able to see the `.obsidian` folder!) 27 | 28 | ## Usage 29 | 30 | Use the command palette and activate the `Global Search and Replace: Search and Replace in all files` command. 31 | 32 | ### Specifying a string as the replacement 33 | 34 | The replacement string can include the following special replacement patterns: 35 | 36 | | Pattern | Inserts | 37 | | --------- | ---------------------------------------------------------------------------------------------- | 38 | | `$$` | Inserts a `"$"`. | 39 | | `$&` | Inserts the matched substring. | 40 | | `` $` `` | Inserts the portion of the string that precedes the matched substring. | 41 | | `$'` | Inserts the portion of the string that follows the matched substring. | 42 | | `$n` | Inserts the `n`th (`1`-indexed) capturing group where `n` is a positive integer less than 100. | 43 | | `$` | Inserts the named capturing group where `Name` is the group name. | 44 | 45 | `$n` and `$` are only available if the `pattern` argument is a [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) object. If the `pattern` is a string, or if the corresponding capturing group isn't present in the regex, then the pattern will be replaced as a literal. If the group is present but isn't matched (because it's part of a disjunction), it will be replaced with an empty string. 46 | 47 | JSCopy to Clipboard 48 | 49 | ```javascript 50 | "foo" replace /(f)/,"$2" 51 | // "$2oo"; the regex doesn't have the second group 52 | 53 | "foo" replace "f","$1" 54 | // "$1oo"; the pattern is a string, so it doesn't have any groups 55 | 56 | "foo" replace /(f)|(g)/,"$2" 57 | // "oo"; the second group exists but isn't matched 58 | ``` 59 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release Obsidian plugin 2 | 3 | on: 4 | push: 5 | tags: 6 | - "*" 7 | 8 | env: 9 | PLUGIN_NAME: global-search-and-replace 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - name: Checkout the code 17 | uses: actions/checkout@v2 18 | 19 | - name: Install Node.js 20 | uses: actions/setup-node@v1 21 | with: 22 | node-version: "19.4.0" 23 | 24 | - name: Build the code 25 | id: build 26 | run: | 27 | npm install 28 | npm run build 29 | mkdir ${{ env.PLUGIN_NAME }} 30 | cp main.js manifest.json styles.css ${{ env.PLUGIN_NAME }} 31 | zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }} 32 | ls 33 | echo "::set-output name=tag_name::$(git tag --sort version:refname | tail -n 1)" 34 | 35 | - name: Create release 36 | id: create_release 37 | uses: actions/create-release@v1 38 | env: 39 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 40 | VERSION: ${{ github.ref }} 41 | with: 42 | tag_name: ${{ github.ref }} 43 | release_name: ${{ github.ref }} 44 | draft: false 45 | prerelease: false 46 | 47 | - name: Upload zip file 48 | id: upload-zip 49 | uses: actions/upload-release-asset@v1 50 | env: 51 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 52 | with: 53 | upload_url: ${{ steps.create_release.outputs.upload_url }} 54 | asset_path: ./${{ env.PLUGIN_NAME }}.zip 55 | asset_name: ${{ env.PLUGIN_NAME }}-${{ steps.build.outputs.tag_name }}.zip 56 | asset_content_type: application/zip 57 | 58 | - name: Upload main.js 59 | id: upload-main 60 | uses: actions/upload-release-asset@v1 61 | env: 62 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 63 | with: 64 | upload_url: ${{ steps.create_release.outputs.upload_url }} 65 | asset_path: ./main.js 66 | asset_name: main.js 67 | asset_content_type: text/javascript 68 | 69 | - name: Upload manifest.json 70 | id: upload-manifest 71 | uses: actions/upload-release-asset@v1 72 | env: 73 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 74 | with: 75 | upload_url: ${{ steps.create_release.outputs.upload_url }} 76 | asset_path: ./manifest.json 77 | asset_name: manifest.json 78 | asset_content_type: application/json 79 | 80 | - name: Upload styles.css 81 | id: upload-css 82 | uses: actions/upload-release-asset@v1 83 | env: 84 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 85 | with: 86 | upload_url: ${{ steps.create_release.outputs.upload_url }} 87 | asset_path: ./styles.css 88 | asset_name: styles.css 89 | asset_content_type: text/css 90 | 91 | -------------------------------------------------------------------------------- /src/domain/file-operator.ts: -------------------------------------------------------------------------------- 1 | import { App, Editor, TFile } from "obsidian"; 2 | import { SearchResult } from "./search-result"; 3 | import { isBlank } from "../util/utils"; 4 | 5 | const NEW_LINE_REGEX = /\r?\n|\r|\n/g; 6 | 7 | interface SearchOperationResult { 8 | searchResults: SearchResult[]; 9 | numberOfFilesWithMatches: number; 10 | } 11 | 12 | export interface ReplaceOperationResult { 13 | lineSearchResults: SearchResult[]; 14 | filePath: string; 15 | lineNumber: number; 16 | } 17 | 18 | const EMPTY_SEARCH_OPERATION_RESULT = { 19 | numberOfFilesWithMatches: 0, 20 | searchResults: [], 21 | }; 22 | 23 | export class FileOperator { 24 | private app: App; 25 | 26 | constructor(app: App) { 27 | this.app = app; 28 | } 29 | 30 | public async search( 31 | query: string, 32 | regexEnabled: boolean, 33 | caseSensitivityEnabled: boolean 34 | ): Promise { 35 | if (isBlank(query)) { 36 | return EMPTY_SEARCH_OPERATION_RESULT; 37 | } 38 | 39 | const queryRegex = this.createQueryRegex(query, regexEnabled, caseSensitivityEnabled); 40 | const markdownFiles = this.app.vault.getMarkdownFiles(); 41 | const searchResults: SearchResult[] = []; 42 | 43 | let numberOfFilesWithMatches = 0; 44 | 45 | for (const file of markdownFiles) { 46 | const contents = await this.app.vault.read(file); 47 | const lines = this.splitIntoLines(contents); 48 | let foundAMatchInCurrentFile = false; 49 | 50 | lines.forEach((line, i) => { 51 | const intermediateResults: SearchResult[] = this.searchInLine( 52 | line, 53 | i + 1, 54 | file, 55 | queryRegex 56 | ); 57 | 58 | if (intermediateResults.length !== 0) { 59 | foundAMatchInCurrentFile = true; 60 | } 61 | 62 | searchResults.push(...intermediateResults); 63 | }); 64 | 65 | if (foundAMatchInCurrentFile) { 66 | numberOfFilesWithMatches++; 67 | foundAMatchInCurrentFile = false; 68 | } 69 | } 70 | 71 | return { searchResults, numberOfFilesWithMatches }; 72 | } 73 | 74 | private createQueryRegex( 75 | query: string, 76 | regexEnabled: boolean, 77 | caseSensitivityEnabled: boolean 78 | ) { 79 | let flags = "g"; 80 | if (!caseSensitivityEnabled) { 81 | flags += "i"; 82 | } 83 | query = regexEnabled ? query : this.escapeRegexString(query); 84 | return new RegExp(query, flags); 85 | } 86 | 87 | private searchInLine( 88 | line: string, 89 | lineNumber: number, 90 | file: TFile, 91 | queryRegex: RegExp 92 | ): SearchResult[] { 93 | const matches = line.matchAll(queryRegex); 94 | 95 | return [...matches].map((match: RegExpMatchArray) => { 96 | if (match.index === undefined) 97 | throw new Error("Regex match index was undefined. This should never happen."); 98 | 99 | return new SearchResult( 100 | line, 101 | lineNumber, 102 | file.path, 103 | match.index, 104 | match.index + match[0].length - 1, 105 | file 106 | ); 107 | }); 108 | } 109 | 110 | private splitIntoLines(contents: string) { 111 | return contents.split(NEW_LINE_REGEX); 112 | } 113 | 114 | public async replace( 115 | searchResult: SearchResult, 116 | replacementText: string, 117 | query: string, 118 | regexEnabled: boolean, 119 | caseSensitivityEnabled: boolean 120 | ): Promise { 121 | const file = searchResult.file; 122 | if (!file) return; 123 | 124 | await this.app.workspace.openLinkText(searchResult.filePath, ""); 125 | const activeEditor = this.app.workspace.activeEditor; 126 | 127 | const editingTheCorrectFile = activeEditor?.file === file; 128 | if (!editingTheCorrectFile) return; 129 | 130 | const editor: Editor | undefined = activeEditor?.editor; 131 | if (!editor) return; 132 | 133 | editor.setSelection( 134 | { 135 | line: searchResult.lineNumber - 1, 136 | ch: searchResult.matchStartIndex, 137 | }, 138 | { 139 | line: searchResult.lineNumber - 1, 140 | ch: searchResult.matchEndIndex + 1, 141 | } 142 | ); 143 | 144 | const queryRegex = this.createQueryRegex(query, regexEnabled, caseSensitivityEnabled); 145 | 146 | // Replace the selection with replacementText 147 | if (regexEnabled) { 148 | editor.replaceSelection(editor.getSelection().replaceAll(queryRegex, replacementText)); 149 | } else { 150 | editor.replaceSelection(replacementText); 151 | } 152 | 153 | // Force flush of editor change to prevent race condition 154 | // where if the user edits the query, stale results are returned for a ~1 second 155 | await this.app.vault.modify(file, editor.getValue()); 156 | 157 | // Necessary to update matchStartIndex and matchEndIndex for search results that were on the same line 158 | const lineSearchResults = this.searchInLine( 159 | editor.getLine(searchResult.lineNumber - 1), 160 | searchResult.lineNumber, 161 | file, 162 | queryRegex 163 | ); 164 | 165 | return { 166 | lineSearchResults: lineSearchResults, 167 | filePath: file.path, 168 | lineNumber: searchResult.lineNumber, 169 | }; 170 | } 171 | 172 | public async open(searchResult: SearchResult): Promise { 173 | if (searchResult.filePath) { 174 | await this.app.workspace.openLinkText(searchResult.filePath, ""); 175 | const activeEditor = this.app.workspace.activeEditor; 176 | 177 | const editingTheCorrectFile = activeEditor?.file === searchResult.file; 178 | if (!editingTheCorrectFile) return; 179 | 180 | const editor: Editor | undefined = activeEditor?.editor; 181 | if (!editor) return; 182 | 183 | editor.setSelection( 184 | { 185 | line: searchResult.lineNumber - 1, 186 | ch: searchResult.matchStartIndex, 187 | }, 188 | { 189 | line: searchResult.lineNumber - 1, 190 | ch: searchResult.matchEndIndex + 1, 191 | } 192 | ); 193 | } 194 | } 195 | 196 | private escapeRegexString(str: string): string { 197 | return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); 198 | } 199 | } 200 | -------------------------------------------------------------------------------- /src/react-components/SearchAndReplace.tsx: -------------------------------------------------------------------------------- 1 | import * as React from "react"; 2 | import { useCallback, useReducer } from "react"; 3 | import { PromptInstructions } from "./PromptInstructions"; 4 | import SearchInput from "./SearchInput"; 5 | import { ReplaceInput } from "./ReplaceInput"; 6 | import SearchResultsContainer from "./SearchResultsContainer"; 7 | import { SearchResult } from "../domain/search-result"; 8 | import { findLastIndex } from "../util/utils"; 9 | import { ResultsNumberSummary } from "./ResultsNumberSummary"; 10 | import { FileOperator, ReplaceOperationResult } from "../domain/file-operator"; 11 | import { useReplaceSelection } from "./use-replace-selection"; 12 | import { useScrollSelectedSearchResultIntoView } from "./use-scroll-selected-search-result-into-view"; 13 | import { useOpenSelectionInEditor } from "./use-open-selection-in-editor"; 14 | import { useBindObsidianEventHandlers } from "./use-bind-obsidian-event-handlers"; 15 | import { useSearch } from "./use-search"; 16 | 17 | const NUMBER_OF_RESULTS_TO_DISPLAY_PER_BATCH = 20; 18 | 19 | interface SearchAndReplaceProps { 20 | fileOperator: FileOperator; 21 | } 22 | 23 | export interface SearchAndReplaceState { 24 | searchQuery: string; 25 | replacementText: string; 26 | selectedIndex: number; 27 | numberOfResultsToDisplay: number; 28 | regexEnabled: boolean; 29 | caseSensitivityEnabled: boolean; 30 | searchResults: SearchResult[]; 31 | numberOfFilesWithMatches: number; 32 | } 33 | 34 | export type SearchAndReplaceAction = 35 | | { type: "clear" } 36 | | { type: "move_selection_up" } 37 | | { type: "move_selection_down" } 38 | | { type: "update_replacement_text"; nextReplacementText: string } 39 | | { type: "update_search_query"; nextSearchQuery: string } 40 | | { type: "update_selected_index"; nextSelectedIndex: number } 41 | | { type: "toggle_regex_enabled" } 42 | | { type: "toggle_case_sensitivity_enabled" } 43 | | { type: "scroll_threshold_exceeded" } 44 | | { 45 | type: "search"; 46 | payload: { nextSearchResults: SearchResult[]; nextNumberOfFilesWithMatches: number }; 47 | } 48 | | { type: "replace"; replaceOperationResult?: ReplaceOperationResult }; 49 | 50 | function reducer( 51 | state: SearchAndReplaceState, 52 | action: SearchAndReplaceAction 53 | ): SearchAndReplaceState { 54 | switch (action.type) { 55 | case "clear": { 56 | return { 57 | ...state, 58 | searchResults: [], 59 | numberOfFilesWithMatches: 0, 60 | }; 61 | } 62 | case "move_selection_up": { 63 | const { selectedIndex } = state; 64 | const nextSelectedIndex = selectedIndex === 0 ? selectedIndex : selectedIndex - 1; 65 | return { ...state, selectedIndex: nextSelectedIndex }; 66 | } 67 | case "move_selection_down": { 68 | const { selectedIndex, searchResults } = state; 69 | const nextSelectedIndex = 70 | selectedIndex === searchResults.length - 1 ? selectedIndex : selectedIndex + 1; 71 | return { ...state, selectedIndex: nextSelectedIndex }; 72 | } 73 | case "update_replacement_text": { 74 | const { nextReplacementText } = action; 75 | return { ...state, replacementText: nextReplacementText }; 76 | } 77 | case "update_selected_index": { 78 | const { nextSelectedIndex } = action; 79 | return { ...state, selectedIndex: nextSelectedIndex }; 80 | } 81 | case "toggle_regex_enabled": { 82 | const { regexEnabled } = state; 83 | return { ...state, regexEnabled: !regexEnabled }; 84 | } 85 | case "toggle_case_sensitivity_enabled": { 86 | const { caseSensitivityEnabled } = state; 87 | return { ...state, caseSensitivityEnabled: !caseSensitivityEnabled }; 88 | } 89 | case "scroll_threshold_exceeded": { 90 | const { numberOfResultsToDisplay } = state; 91 | const nextNumberOfResultsToDisplay = 92 | numberOfResultsToDisplay + NUMBER_OF_RESULTS_TO_DISPLAY_PER_BATCH; 93 | return { ...state, numberOfResultsToDisplay: nextNumberOfResultsToDisplay }; 94 | } 95 | case "search": { 96 | const { nextSearchResults, nextNumberOfFilesWithMatches } = action.payload; 97 | return { 98 | ...state, 99 | searchResults: nextSearchResults, 100 | numberOfFilesWithMatches: nextNumberOfFilesWithMatches, 101 | selectedIndex: 0, 102 | numberOfResultsToDisplay: NUMBER_OF_RESULTS_TO_DISPLAY_PER_BATCH, 103 | }; 104 | } 105 | case "update_search_query": { 106 | const { nextSearchQuery } = action; 107 | return { ...state, searchQuery: nextSearchQuery }; 108 | } 109 | case "replace": { 110 | const { replaceOperationResult } = action; 111 | const { searchResults, selectedIndex } = state; 112 | 113 | if (!replaceOperationResult) { 114 | const nextSearchResults = searchResults.filter((_, i) => i !== selectedIndex); 115 | return { ...state, searchResults: nextSearchResults }; 116 | } 117 | 118 | const hasSameFilePathAndLineNumber = (r: SearchResult) => { 119 | const samePath = r.filePath === replaceOperationResult.filePath; 120 | const sameLineNumber = r.lineNumber === replaceOperationResult.lineNumber; 121 | return samePath && sameLineNumber; 122 | }; 123 | 124 | const firstIndexOfSamePathAndLineNumber = searchResults.findIndex( 125 | hasSameFilePathAndLineNumber 126 | ); 127 | 128 | const lastIndexOfSamePathAndLineNumber = findLastIndex( 129 | searchResults, 130 | hasSameFilePathAndLineNumber 131 | ); 132 | 133 | const outOfBounds = selectedIndex > searchResults.length - 2; 134 | const nextSelectedIndex = outOfBounds ? selectedIndex - 1 : selectedIndex; 135 | 136 | const nextSearchResults = [ 137 | ...searchResults.slice(0, firstIndexOfSamePathAndLineNumber), 138 | ...replaceOperationResult.lineSearchResults, 139 | ...searchResults.slice(lastIndexOfSamePathAndLineNumber + 1), 140 | ]; 141 | 142 | return { 143 | ...state, 144 | searchResults: nextSearchResults, 145 | selectedIndex: nextSelectedIndex, 146 | }; 147 | } 148 | default: { 149 | throw new Error(`Unhandled action type: ${action}`); 150 | } 151 | } 152 | } 153 | 154 | export default function SearchAndReplace({ fileOperator }: SearchAndReplaceProps) { 155 | const [state, dispatch] = useReducer(reducer, { 156 | searchQuery: "", 157 | replacementText: "", 158 | selectedIndex: 0, 159 | numberOfResultsToDisplay: NUMBER_OF_RESULTS_TO_DISPLAY_PER_BATCH, 160 | regexEnabled: false, 161 | caseSensitivityEnabled: false, 162 | searchResults: [], 163 | numberOfFilesWithMatches: 0, 164 | }); 165 | 166 | 167 | useSearch(state, dispatch, fileOperator); 168 | useScrollSelectedSearchResultIntoView(state.selectedIndex); 169 | 170 | const replaceSelection = useReplaceSelection(state, dispatch, fileOperator); 171 | const openSelectionInEditor = useOpenSelectionInEditor(fileOperator, state); 172 | useBindObsidianEventHandlers(dispatch, replaceSelection, openSelectionInEditor); 173 | 174 | const handleReplaceInputChanged = useCallback((event: React.ChangeEvent) => { 175 | dispatch({ type: "update_replacement_text", nextReplacementText: event.target.value }); 176 | }, []); 177 | 178 | const handleSearchInputChanged = useCallback((event: React.ChangeEvent) => { 179 | dispatch({ type: "update_search_query", nextSearchQuery: event.target.value }); 180 | }, []); 181 | 182 | const handleScrollThresholdExceeded = useCallback(() => { 183 | dispatch({ type: "scroll_threshold_exceeded" }); 184 | }, []); 185 | 186 | const handleSelectedIndexChanged = useCallback((i: number) => { 187 | dispatch({ type: "update_selected_index", nextSelectedIndex: i }); 188 | }, []); 189 | 190 | const handleToggleRegexSearch = useCallback(() => { 191 | dispatch({ type: "clear" }); 192 | dispatch({ type: "toggle_regex_enabled" }); 193 | }, []); 194 | 195 | const handleToggleCaseSensitiveSearch = useCallback(() => { 196 | dispatch({ type: "clear" }); 197 | dispatch({ type: "toggle_case_sensitivity_enabled" }); 198 | }, []); 199 | 200 | return ( 201 | <> 202 | 210 | 211 | 219 | 223 | 224 | 225 | ); 226 | } 227 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------