├── public └── .gitkeep ├── .vscode ├── settings.json └── extensions.json ├── src-tauri ├── build.rs ├── icons │ ├── 32x32.png │ ├── icon.icns │ ├── icon.ico │ ├── icon.png │ ├── 128x128.png │ ├── 128x128@2x.png │ ├── StoreLogo.png │ ├── Square30x30Logo.png │ ├── Square44x44Logo.png │ ├── Square71x71Logo.png │ ├── Square89x89Logo.png │ ├── Square107x107Logo.png │ ├── Square142x142Logo.png │ ├── Square150x150Logo.png │ ├── Square284x284Logo.png │ └── Square310x310Logo.png ├── .gitignore ├── src │ ├── main.rs │ └── lib.rs ├── capabilities │ └── default.json ├── tauri.conf.json └── Cargo.toml ├── httpok-logo.png ├── httpok_icons.zip ├── static ├── favicon.png ├── vite.svg ├── svelte.svg └── tauri.svg ├── screenshot-v0.8.0.png ├── .gitignore ├── src ├── lib │ ├── httpOkFullResponse.ts │ ├── httpOkRequest.ts │ ├── httpOkLanguageService.ts │ ├── lexer.ts │ ├── parser.ts │ ├── visitor.ts │ └── httpOkLanguage.ts ├── routes │ ├── +layout.ts │ └── +page.svelte └── app.html ├── svelte.config.js ├── tsconfig.json ├── vite.config.js ├── package.json ├── README.md └── LICENSE.txt /public/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "svelte.enable-ts-plugin": true 3 | } 4 | -------------------------------------------------------------------------------- /src-tauri/build.rs: -------------------------------------------------------------------------------- 1 | fn main() { 2 | tauri_build::build() 3 | } 4 | -------------------------------------------------------------------------------- /httpok-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/httpok-logo.png -------------------------------------------------------------------------------- /httpok_icons.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/httpok_icons.zip -------------------------------------------------------------------------------- /static/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/static/favicon.png -------------------------------------------------------------------------------- /screenshot-v0.8.0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/screenshot-v0.8.0.png -------------------------------------------------------------------------------- /src-tauri/icons/32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/32x32.png -------------------------------------------------------------------------------- /src-tauri/icons/icon.icns: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/icon.icns -------------------------------------------------------------------------------- /src-tauri/icons/icon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/icon.ico -------------------------------------------------------------------------------- /src-tauri/icons/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/icon.png -------------------------------------------------------------------------------- /src-tauri/icons/128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/128x128.png -------------------------------------------------------------------------------- /src-tauri/icons/128x128@2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/128x128@2x.png -------------------------------------------------------------------------------- /src-tauri/icons/StoreLogo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/StoreLogo.png -------------------------------------------------------------------------------- /src-tauri/icons/Square30x30Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/Square30x30Logo.png -------------------------------------------------------------------------------- /src-tauri/icons/Square44x44Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/Square44x44Logo.png -------------------------------------------------------------------------------- /src-tauri/icons/Square71x71Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/Square71x71Logo.png -------------------------------------------------------------------------------- /src-tauri/icons/Square89x89Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/Square89x89Logo.png -------------------------------------------------------------------------------- /src-tauri/icons/Square107x107Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/Square107x107Logo.png -------------------------------------------------------------------------------- /src-tauri/icons/Square142x142Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/Square142x142Logo.png -------------------------------------------------------------------------------- /src-tauri/icons/Square150x150Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/Square150x150Logo.png -------------------------------------------------------------------------------- /src-tauri/icons/Square284x284Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/Square284x284Logo.png -------------------------------------------------------------------------------- /src-tauri/icons/Square310x310Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iondodon/httpok/HEAD/src-tauri/icons/Square310x310Logo.png -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "svelte.svelte-vscode", 4 | "tauri-apps.tauri-vscode", 5 | "rust-lang.rust-analyzer" 6 | ] 7 | } 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules 3 | /build 4 | /.svelte-kit 5 | /package 6 | .env 7 | .env.* 8 | !.env.example 9 | vite.config.js.timestamp-* 10 | vite.config.ts.timestamp-* 11 | -------------------------------------------------------------------------------- /src-tauri/.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by Cargo 2 | # will have compiled files and executables 3 | /target/ 4 | 5 | # Generated by Tauri 6 | # will have schema files for capabilities auto-completion 7 | /gen/schemas 8 | -------------------------------------------------------------------------------- /src-tauri/src/main.rs: -------------------------------------------------------------------------------- 1 | // Prevents additional console window on Windows in release, DO NOT REMOVE!! 2 | #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] 3 | 4 | fn main() { 5 | httpok_lib::run() 6 | } 7 | -------------------------------------------------------------------------------- /src/lib/httpOkFullResponse.ts: -------------------------------------------------------------------------------- 1 | export interface HttpOkFullResponse { 2 | status: number; 3 | statusText: string; 4 | url: string; 5 | ok: boolean; 6 | headers: Record; 7 | body: string; 8 | [key: string]: any; 9 | } 10 | -------------------------------------------------------------------------------- /src/routes/+layout.ts: -------------------------------------------------------------------------------- 1 | // Tauri doesn't have a Node.js server to do proper SSR 2 | // so we will use adapter-static to prerender the app (SSG) 3 | // See: https://v2.tauri.app/start/frontend/sveltekit/ for more info 4 | export const prerender = true; 5 | export const ssr = false; 6 | -------------------------------------------------------------------------------- /src-tauri/capabilities/default.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "../gen/schemas/desktop-schema.json", 3 | "identifier": "default", 4 | "description": "Capability for the main window", 5 | "windows": [ 6 | "main" 7 | ], 8 | "permissions": [ 9 | "core:default", 10 | "opener:default" 11 | ] 12 | } -------------------------------------------------------------------------------- /svelte.config.js: -------------------------------------------------------------------------------- 1 | // Tauri doesn't have a Node.js server to do proper SSR 2 | // so we will use adapter-static to prerender the app (SSG) 3 | // See: https://v2.tauri.app/start/frontend/sveltekit/ for more info 4 | import adapter from "@sveltejs/adapter-static"; 5 | import { vitePreprocess } from "@sveltejs/vite-plugin-svelte"; 6 | 7 | /** @type {import('@sveltejs/kit').Config} */ 8 | const config = { 9 | preprocess: vitePreprocess(), 10 | kit: { 11 | adapter: adapter(), 12 | }, 13 | }; 14 | 15 | export default config; 16 | -------------------------------------------------------------------------------- /src/app.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Tauri + SvelteKit + Typescript App 8 | %sveltekit.head% 9 | 16 | 17 | 18 |
%sveltekit.body%
19 | 20 | 21 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./.svelte-kit/tsconfig.json", 3 | "compilerOptions": { 4 | "allowJs": true, 5 | "checkJs": true, 6 | "esModuleInterop": true, 7 | "forceConsistentCasingInFileNames": true, 8 | "resolveJsonModule": true, 9 | "skipLibCheck": true, 10 | "sourceMap": true, 11 | "strict": true, 12 | "moduleResolution": "bundler" 13 | } 14 | // Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias 15 | // except $lib which is handled by https://kit.svelte.dev/docs/configuration#files 16 | // 17 | // If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes 18 | // from the referenced tsconfig.json - TypeScript does not merge them in 19 | } 20 | -------------------------------------------------------------------------------- /src-tauri/tauri.conf.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://schema.tauri.app/config/2", 3 | "productName": "httpok", 4 | "version": "0.8.0", 5 | "identifier": "com.httpok.app", 6 | "build": { 7 | "beforeDevCommand": "npm run dev", 8 | "devUrl": "http://localhost:1420", 9 | "beforeBuildCommand": "npm run build", 10 | "frontendDist": "../build" 11 | }, 12 | "app": { 13 | "windows": [ 14 | { 15 | "title": "httpok", 16 | "width": 1280, 17 | "height": 800 18 | } 19 | ], 20 | "security": { 21 | "csp": null 22 | } 23 | }, 24 | "bundle": { 25 | "active": true, 26 | "targets": "all", 27 | "icon": [ 28 | "icons/32x32.png", 29 | "icons/128x128.png", 30 | "icons/128x128@2x.png", 31 | "icons/icon.icns", 32 | "icons/icon.ico" 33 | ] 34 | } 35 | } -------------------------------------------------------------------------------- /vite.config.js: -------------------------------------------------------------------------------- 1 | import { defineConfig } from "vite"; 2 | import { sveltekit } from "@sveltejs/kit/vite"; 3 | import { viteStaticCopy } from 'vite-plugin-static-copy'; 4 | 5 | // @ts-expect-error process is a nodejs global 6 | const host = process.env.TAURI_DEV_HOST; 7 | 8 | export default defineConfig(() => ({ 9 | plugins: [ 10 | sveltekit(), 11 | viteStaticCopy({ 12 | targets: [ 13 | { 14 | src: 'node_modules/monaco-editor/min', 15 | dest: 'monaco-editor', 16 | }, 17 | ], 18 | }), 19 | ], 20 | clearScreen: false, 21 | server: { 22 | port: 1420, 23 | strictPort: true, 24 | host: host || false, 25 | hmr: host 26 | ? { 27 | protocol: "ws", 28 | host, 29 | port: 1421, 30 | } 31 | : undefined, 32 | watch: { 33 | ignored: ["**/src-tauri/**"], 34 | }, 35 | }, 36 | })); 37 | -------------------------------------------------------------------------------- /src/lib/httpOkRequest.ts: -------------------------------------------------------------------------------- 1 | export class HttpOkRequest { 2 | method: string; 3 | url: string; 4 | headers?: Record; 5 | body?: string | null; 6 | isMultipart: boolean; 7 | 8 | constructor( 9 | url: string, 10 | { 11 | method, 12 | headers, 13 | body, 14 | }: { 15 | method: string; 16 | headers?: Record; 17 | body?: string | null; 18 | } 19 | ) { 20 | this.url = url; 21 | this.method = method; 22 | this.headers = headers; 23 | this.body = body ?? null; 24 | this.isMultipart = headers?.['Content-Type']?.toLowerCase().includes('multipart/form-data') ?? false; 25 | } 26 | 27 | toSerializable(): object { 28 | return { 29 | method: this.method, 30 | url: this.url, 31 | headers: this.headers ?? {}, 32 | body: this.body, 33 | is_multipart: this.isMultipart, 34 | }; 35 | } 36 | } -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "httpok", 3 | "version": "0.8.0", 4 | "description": "", 5 | "type": "module", 6 | "scripts": { 7 | "dev": "vite dev", 8 | "build": "vite build", 9 | "preview": "vite preview", 10 | "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json", 11 | "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch", 12 | "tauri": "tauri" 13 | }, 14 | "license": "GPLv3", 15 | "dependencies": { 16 | "@monaco-editor/loader": "^1.5.0", 17 | "@tauri-apps/api": "^2", 18 | "@tauri-apps/plugin-opener": "^2", 19 | "chevrotain": "^11.0.3" 20 | }, 21 | "devDependencies": { 22 | "@sveltejs/adapter-static": "^3.0.6", 23 | "@sveltejs/kit": "^2.9.0", 24 | "@sveltejs/vite-plugin-svelte": "^5.0.0", 25 | "@tauri-apps/cli": "^2", 26 | "monaco-editor": "^0.52.2", 27 | "svelte": "^5.0.0", 28 | "svelte-check": "^4.0.0", 29 | "typescript": "~5.6.2", 30 | "vite": "^6.0.3", 31 | "vite-plugin-static-copy": "^2.3.1" 32 | } 33 | } -------------------------------------------------------------------------------- /src-tauri/Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "httpok" 3 | version = "0.8.0" 4 | description = "Desktop HTTP client" 5 | authors = ["Ion Dodon"] 6 | edition = "2021" 7 | 8 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 9 | 10 | [lib] 11 | # The `_lib` suffix may seem redundant but it is necessary 12 | # to make the lib name unique and wouldn't conflict with the bin name. 13 | # This seems to be only an issue on Windows, see https://github.com/rust-lang/cargo/issues/8519 14 | name = "httpok_lib" 15 | crate-type = ["staticlib", "cdylib", "rlib"] 16 | 17 | [build-dependencies] 18 | tauri-build = { version = "2", features = [] } 19 | 20 | [dependencies] 21 | tauri = { version = "2", features = [] } 22 | tauri-plugin-opener = "2" 23 | tauri-plugin-dialog = "2.2.1" 24 | serde = { version = "1", features = ["derive"] } 25 | serde_json = "1" 26 | reqwest = { version = "0.11", features = ["blocking", "multipart"] } 27 | tokio = { version = "1", features = [ 28 | "rt-multi-thread", 29 | "macros", 30 | "fs", 31 | "io-util", 32 | ] } 33 | -------------------------------------------------------------------------------- /src/lib/httpOkLanguageService.ts: -------------------------------------------------------------------------------- 1 | import type { HttpOkFullResponse } from './httpOkFullResponse'; 2 | import type { HttpOkRequest } from './httpOkRequest'; 3 | import { parseRequests } from './visitor' 4 | import { invoke } from '@tauri-apps/api/core'; 5 | 6 | export class HttpOkLanguageService { 7 | async execute(input: string): Promise { 8 | const responses = []; 9 | 10 | const requests = parseRequests(input); 11 | 12 | for (const request of requests) { 13 | const response = await this.fetchWithFullResponse(request); 14 | responses.push(response); 15 | } 16 | 17 | return responses; 18 | } 19 | 20 | async fetchWithFullResponse(request: HttpOkRequest): Promise { 21 | const response: HttpOkFullResponse = await invoke('fetch_with_full_response', { 22 | request: request.toSerializable() 23 | }); 24 | 25 | const contentType = response.headers['content-type']?.toLowerCase(); 26 | 27 | if (contentType?.includes('application/json')) { 28 | try { 29 | response.body = JSON.parse(response.body); 30 | } catch (e) { 31 | console.warn('Invalid JSON body despite application/json header'); 32 | // Leave body as string 33 | } 34 | } 35 | 36 | return response; 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /src/lib/lexer.ts: -------------------------------------------------------------------------------- 1 | import { createToken, Lexer } from "chevrotain"; 2 | 3 | export const Comment = createToken({ 4 | name: "Comment", 5 | pattern: /#[^\n\r]*/, 6 | line_breaks: false, 7 | }); 8 | 9 | export const Method = createToken({ 10 | name: "Method", 11 | pattern: /GET|POST|PUT|DELETE|PATCH|OPTIONS|HEAD/, 12 | }); 13 | 14 | export const Url = createToken({ 15 | name: "Url", 16 | pattern: /https?:\/\/[^\s]+/, 17 | }); 18 | 19 | export const BodyDelimiter = createToken({ 20 | name: "BodyDelimiter", 21 | pattern: /---/, 22 | }); 23 | 24 | export const BodyLine = createToken({ 25 | name: "BodyLine", 26 | pattern: /[^\n\r]+/, 27 | line_breaks: false, 28 | }); 29 | 30 | export const Header = createToken({ 31 | name: "Header", 32 | pattern: /[A-Za-z0-9\-]+:\s*[^\n\r]+/, 33 | line_breaks: false, 34 | }); 35 | 36 | export const Newline = createToken({ 37 | name: "Newline", 38 | pattern: /\r?\n/, 39 | line_breaks: true, 40 | }); 41 | 42 | export const WhiteSpace = createToken({ 43 | name: "WhiteSpace", 44 | pattern: /[ \t]+/, 45 | group: Lexer.SKIPPED, 46 | }); 47 | 48 | export const allTokens = [ 49 | WhiteSpace, 50 | Comment, 51 | Method, 52 | Url, 53 | BodyDelimiter, 54 | Header, 55 | BodyLine, 56 | Newline 57 | ]; 58 | 59 | export const SimpleLexer = new Lexer(allTokens); 60 | 61 | -------------------------------------------------------------------------------- /static/vite.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /static/svelte.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/lib/parser.ts: -------------------------------------------------------------------------------- 1 | import { CstParser, EOF } from "chevrotain"; 2 | import { allTokens, Method, Comment, Url, BodyLine, BodyDelimiter, Header, Newline } from "./lexer.js"; // make sure extension matches your setup 3 | 4 | export class HttpParser extends CstParser { 5 | [x: string]: any; 6 | constructor() { 7 | super(allTokens); 8 | 9 | const $ = this; 10 | 11 | $.RULE("commentBlock", () => { 12 | $.AT_LEAST_ONE(() => { 13 | $.CONSUME(Comment); 14 | $.OPTION(() => $.CONSUME(Newline)); 15 | }); 16 | }); 17 | 18 | $.RULE("program", () => { 19 | $.MANY(() => { 20 | $.SUBRULE($.httpRequest); 21 | }); 22 | 23 | $.MANY8(() => { 24 | $.OR([ 25 | { ALT: () => $.SUBRULE8($.commentBlock) }, 26 | { ALT: () => $.CONSUME8(Newline) } 27 | ]); 28 | }); 29 | 30 | $.OPTION(() => $.CONSUME(EOF)); 31 | }); 32 | 33 | $.RULE("requestBody", () => { 34 | $.CONSUME1(BodyDelimiter); 35 | $.CONSUME2(Newline); 36 | 37 | $.MANY(() => { 38 | $.CONSUME3(BodyLine); 39 | $.CONSUME4(Newline); 40 | }); 41 | 42 | $.CONSUME5(BodyDelimiter); 43 | $.OPTION(() => $.CONSUME6(Newline)); 44 | }); 45 | 46 | $.RULE("httpRequest", () => { 47 | $.MANY(() => { 48 | $.OR([ 49 | { ALT: () => $.SUBRULE($.commentBlock) }, 50 | { ALT: () => $.CONSUME(Newline) } 51 | ]); 52 | }); 53 | 54 | $.CONSUME1(Method); 55 | $.CONSUME2(Url); 56 | $.CONSUME3(Newline); 57 | 58 | $.MANY4(() => { 59 | $.CONSUME4(Header); 60 | $.CONSUME4(Newline); 61 | }); 62 | 63 | $.OPTION(() => { 64 | $.SUBRULE($.requestBody); 65 | }); 66 | 67 | $.MANY7(() => { 68 | $.OR7([ 69 | { ALT: () => $.SUBRULE7($.commentBlock) }, 70 | { ALT: () => $.CONSUME7(Newline) } 71 | ]); 72 | }); 73 | }); 74 | 75 | this.performSelfAnalysis(); 76 | } 77 | } 78 | -------------------------------------------------------------------------------- /src/lib/visitor.ts: -------------------------------------------------------------------------------- 1 | import { SimpleLexer } from "./lexer.js"; 2 | import { HttpParser } from "./parser.js"; 3 | import { HttpOkRequest } from "./httpOkRequest.js"; 4 | 5 | const parser = new HttpParser(); 6 | const BaseVisitor = parser.getBaseCstVisitorConstructorWithDefaults(); 7 | 8 | class Visitor extends BaseVisitor { 9 | requests: HttpOkRequest[] = []; 10 | 11 | constructor() { 12 | super(); 13 | this.validateVisitor(); 14 | } 15 | 16 | program(ctx: any) { 17 | for (const request of ctx.httpRequest ?? []) { 18 | this.visit(request); 19 | } 20 | } 21 | 22 | requestBody(ctx: any) { 23 | if (!ctx.BodyLine) return null; 24 | return ctx.BodyLine.map((b: any) => b.image).join('\n'); 25 | } 26 | 27 | httpRequest(ctx: any) { 28 | const method = ctx.Method[0].image; 29 | const url = ctx.Url[0].image; 30 | const headers: Record = {}; 31 | 32 | if (ctx.Header) { 33 | for (const h of ctx.Header) { 34 | const [key, ...valueParts] = h.image.split(":"); 35 | headers[key.trim()] = valueParts.join(":").trim(); 36 | } 37 | } 38 | 39 | let body: string | undefined = undefined; 40 | 41 | if (ctx.requestBody) { 42 | body = this.visit(ctx.requestBody[0]); 43 | } 44 | 45 | const req = new HttpOkRequest(url, { 46 | method, 47 | headers: headers, 48 | body: body ?? null, 49 | }); 50 | 51 | this.requests.push(req); 52 | } 53 | } 54 | 55 | export function parseRequests(code: string): HttpOkRequest[] { 56 | // ensure there is a newline at the end 57 | // this helps to have a simpler grammar 58 | code = code.endsWith("\n") ? code : code + "\n" 59 | const lex = SimpleLexer.tokenize(code); 60 | parser.input = lex.tokens; 61 | 62 | const cst = parser.program(); 63 | if (parser.errors.length > 0) { 64 | console.error(parser.errors); 65 | throw new Error("Parsing error"); 66 | } 67 | 68 | const visitor = new Visitor(); 69 | visitor.visit(cst); 70 | return visitor.requests; 71 | } 72 | -------------------------------------------------------------------------------- /static/tauri.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # httpok 2 | 3 |

4 | 5 |

6 | 7 |

8 | 9 |

10 | 11 | **httpok** is a fast, minimalistic desktop HTTP client built with Tauri and SvelteKit. It lets you compose and test HTTP requests in a code editor interface, offering a lightweight alternative to tools like Postman or Insomnia. 12 | 13 | ### Installation from Releases 14 | 15 | Pre-built binaries are available for download from the [Releases page](https://github.com/iondodon/httpok/releases). Choose the appropriate package for your operating system. 16 | 17 | After downloading, simply run the installer and follow the on-screen instructions. 18 | 19 | --- 20 | 21 | ## Features 22 | 23 | - ✉️ **Write requests like code** – Use a simple, custom DSL to define HTTP requests directly in the built-in editor (powered by Monaco). 24 | - ⏱ **Send and inspect** – Execute multiple requests at once, view response status, headers, and formatted body. 25 | - 🔄 **Multi-request support** – Compose and run multiple HTTP requests from a single input. 26 | - 📊 **JSON highlighting** – Pretty-print responses with syntax highlighting for JSON. 27 | - 📥 **Built with Tauri** – Lightweight cross-platform app with native performance and secure architecture. 28 | 29 | --- 30 | 31 | ## Example Request 32 | 33 | ``` 34 | GET https://jsonplaceholder.typicode.com/posts/1 35 | Accept: application/json 36 | Authorization: Bearer token123 37 | ``` 38 | 39 | --- 40 | 41 | ## Technologies 42 | 43 | - [Tauri](https://tauri.app/) – Native desktop wrapper (Rust) 44 | - [SvelteKit](https://kit.svelte.dev/) – Frontend framework 45 | - [Monaco Editor](https://microsoft.github.io/monaco-editor/) – Code editor component 46 | - [Chevrotain](https://chevrotain.io/) – HTTP request DSL parser 47 | - TypeScript 48 | - Vite 49 | 50 | --- 51 | 52 | ## Getting Started 53 | 54 | ### Prerequisites 55 | 56 | - Node.js 57 | - Rust 58 | - Tauri CLI 59 | 60 | ### Install & Run 61 | 62 | ```bash 63 | git clone https://github.com/iondodon/httpok 64 | cd httpok 65 | npm install 66 | npm run tauri dev 67 | ``` 68 | 69 | ### Build 70 | 71 | ```bash 72 | npm run tauri build 73 | ``` 74 | 75 | --- 76 | 77 | ## Project Structure 78 | 79 | ``` 80 | httpok/ 81 | ├── src-tauri/ # Tauri backend (Rust) 82 | ├── src/ # SvelteKit frontend 83 | │ ├── routes/+page.svelte # Main UI 84 | │ └── lib/ # HTTP DSL parser and executor 85 | ├── static/ # Static assets 86 | ├── vite.config.ts # Vite setup 87 | ├── svelte.config.js # Svelte config 88 | └── package.json 89 | ``` 90 | 91 | --- 92 | 93 | ## License 94 | 95 | httpok is licensed under [GPLv3](https://github.com/iondodon/httpok/blob/main/LICENSE.txt) @ Ion Dodon. 96 | -------------------------------------------------------------------------------- /src/lib/httpOkLanguage.ts: -------------------------------------------------------------------------------- 1 | import * as monaco from "monaco-editor"; 2 | 3 | export function registerHttpOkLanguage() { 4 | monaco.languages.register({ id: "httpok" }); 5 | 6 | // Register custom theme that extends vs-dark 7 | monaco.editor.defineTheme('httpokTheme', { 8 | base: 'vs-dark', 9 | inherit: true, 10 | rules: [], 11 | colors: {} 12 | }); 13 | 14 | monaco.languages.setMonarchTokensProvider("httpok", { 15 | defaultToken: "", 16 | tokenPostfix: ".httpok", 17 | 18 | // JSON states and rules 19 | brackets: [ 20 | { open: "{", close: "}", token: "delimiter.curly" }, 21 | { open: "[", close: "]", token: "delimiter.square" }, 22 | { open: "(", close: ")", token: "delimiter.parenthesis" } 23 | ], 24 | 25 | keywords: ["true", "false", "null"], 26 | 27 | // The main tokenizer for our languages 28 | tokenizer: { 29 | root: [ 30 | // Comments 31 | [/^#.*$/, "comment"], 32 | 33 | // Numbers between triple dashes 34 | [/---\s*(\d+)\s*---/, ["delimiter.dash", "number.special"]], 35 | 36 | // Quoted strings 37 | [/"([^"\\]|\\.)*"/, "string.quoted"], 38 | 39 | // HTTP methods 40 | [/\b(GET|POST|PUT|DELETE|PATCH|OPTIONS|HEAD)\b/, "type.identifier"], 41 | 42 | // URLs 43 | [/\bhttps?:\/\/[^\s]+/, "constant"], 44 | 45 | // Headers 46 | [/^[A-Za-z0-9\-]+(?=\s*:)/, "type.identifier"], 47 | [/:\s*/, "delimiter"], 48 | [/[^:\r\n]+$/, "string"], 49 | 50 | // Body delimiter 51 | [/^---$/, { token: "delimiter.body", next: "@body" }], 52 | 53 | // Whitespace 54 | [/[ \t\r\n]+/, "white"], 55 | ], 56 | 57 | // JSON body state 58 | body: [ 59 | // Exit body state on delimiter 60 | [/^---$/, { token: "delimiter.body", next: "@pop" }], 61 | 62 | // JSON string 63 | [/"([^"\\]|\\.)*$/, "string.invalid"], // non-terminated string 64 | [/"/, { token: "string.quote", bracket: "@open", next: "@string" }], 65 | 66 | // JSON numbers 67 | [/[0-9]+\.[0-9]*([eE][\-+]?[0-9]+)?/, "number.float"], 68 | [/[0-9]+/, "number"], 69 | 70 | // JSON keywords 71 | [/\b(true|false|null)\b/, "keyword"], 72 | 73 | // JSON brackets 74 | [/[{}()\[\]]/, "@brackets"], 75 | 76 | // JSON object key 77 | [/[a-zA-Z_$][\w$]*/, "identifier"], 78 | 79 | // JSON operators 80 | [/[,:]/, "delimiter"], 81 | 82 | // Whitespace 83 | [/\s+/, "white"] 84 | ], 85 | 86 | // JSON string state 87 | string: [ 88 | [/[^\\"]+/, "string"], 89 | [/@escapes/, "string.escape"], 90 | [/\\./, "string.escape.invalid"], 91 | [/"/, { token: "string.quote", bracket: "@close", next: "@pop" }] 92 | ] 93 | }, 94 | 95 | escapes: /\\(?:[bfnrtv\\"']|u[0-9A-Fa-f]{4})/, 96 | }); 97 | 98 | monaco.languages.setLanguageConfiguration("httpok", { 99 | comments: { 100 | lineComment: "#", 101 | }, 102 | brackets: [ 103 | ["{", "}"], 104 | ["[", "]"], 105 | ["(", ")"] 106 | ], 107 | autoClosingPairs: [ 108 | { open: "{", close: "}" }, 109 | { open: "[", close: "]" }, 110 | { open: "(", close: ")" }, 111 | { open: '"', close: '"' } 112 | ], 113 | surroundingPairs: [ 114 | { open: "{", close: "}" }, 115 | { open: "[", close: "]" }, 116 | { open: "(", close: ")" }, 117 | { open: '"', close: '"' } 118 | ] 119 | }); 120 | } 121 | -------------------------------------------------------------------------------- /src-tauri/src/lib.rs: -------------------------------------------------------------------------------- 1 | // Learn more about Tauri commands at https://tauri.app/develop/calling-rust/ 2 | 3 | use reqwest::multipart::{Form, Part}; 4 | use serde::{Deserialize, Serialize}; 5 | use std::collections::HashMap; 6 | use std::path::Path; 7 | use tauri::{ 8 | menu::{MenuBuilder, MenuItemBuilder, SubmenuBuilder}, 9 | Emitter, Manager, Wry, 10 | }; 11 | use tauri_plugin_dialog::{DialogExt, FileDialogBuilder}; 12 | use tokio::fs::File; 13 | use tokio::io::AsyncReadExt; 14 | 15 | #[derive(Deserialize)] 16 | pub struct HttpOkRequest { 17 | pub method: String, 18 | pub url: String, 19 | pub headers: Option>, 20 | pub body: Option, 21 | pub is_multipart: Option, 22 | } 23 | 24 | #[derive(Serialize)] 25 | pub struct HttpOkFullResponse { 26 | #[serde(rename = "durationMiliseconds")] 27 | pub duration_miliseconds: f64, 28 | pub status: u16, 29 | 30 | #[serde(rename = "statusText")] 31 | pub status_text: String, 32 | 33 | pub url: String, 34 | pub ok: bool, 35 | pub headers: HashMap, 36 | pub body: String, 37 | } 38 | 39 | #[tauri::command] 40 | fn greet(name: &str) -> String { 41 | format!("Hello, {}! You've been greeted from Rust!", name) 42 | } 43 | 44 | #[tauri::command] 45 | async fn fetch_with_full_response(request: HttpOkRequest) -> Result { 46 | let client = reqwest::Client::new(); 47 | let method = request.method.parse().unwrap_or(reqwest::Method::GET); 48 | 49 | // Create request builder with a fixed timeout of 30 seconds 50 | let mut req = client.request(method, &request.url); 51 | 52 | // Fixed timeout of 30 seconds for all requests 53 | const TIMEOUT_DURATION: std::time::Duration = std::time::Duration::from_secs(30); 54 | req = req.timeout(TIMEOUT_DURATION); 55 | 56 | if let Some(headers) = request.headers { 57 | for (k, v) in headers { 58 | if k.to_lowercase() != "content-type" || !request.is_multipart.unwrap_or(false) { 59 | req = req.header(k, v); 60 | } 61 | } 62 | } 63 | 64 | if let Some(body) = request.body { 65 | if request.is_multipart.unwrap_or(false) { 66 | let mut form = Form::new(); 67 | println!("file upload: {}", body); 68 | 69 | // Parse the body for file uploads 70 | for line in body.lines() { 71 | if let Some((key, value)) = line.split_once('=') { 72 | if value.starts_with("@") { 73 | // This is a file upload 74 | let file_path = &value[1..]; // Remove the @ prefix 75 | let path = Path::new(file_path); 76 | 77 | if !path.exists() { 78 | return Err(format!("File not found: {}", file_path)); 79 | } 80 | 81 | let mut file = File::open(path).await.map_err(|e| e.to_string())?; 82 | let mut contents = Vec::new(); 83 | file.read_to_end(&mut contents) 84 | .await 85 | .map_err(|e| e.to_string())?; 86 | 87 | let file_name = path.file_name().and_then(|n| n.to_str()).unwrap_or("file"); 88 | 89 | let part = Part::bytes(contents).file_name(file_name.to_string()); 90 | 91 | form = form.part(key.trim().to_string(), part); 92 | } else { 93 | // This is a regular field 94 | form = form.text(key.trim().to_string(), value.trim().to_string()); 95 | } 96 | } 97 | } 98 | req = req.multipart(form); 99 | } else { 100 | println!("body: {}", body); 101 | req = req.body(body); 102 | } 103 | } 104 | 105 | let start = std::time::Instant::now(); 106 | let res = match req.send().await { 107 | Ok(response) => response, 108 | Err(e) => { 109 | if e.is_timeout() { 110 | return Err(format!( 111 | "Request timed out after {} seconds", 112 | TIMEOUT_DURATION.as_secs() 113 | )); 114 | } 115 | return Err(e.to_string()); 116 | } 117 | }; 118 | let duration_miliseconds = start.elapsed().as_secs_f64() * 1000.0; 119 | 120 | let status = res.status().as_u16(); 121 | let status_text = res.status().canonical_reason().unwrap_or("").to_string(); 122 | let url = res.url().to_string(); 123 | let ok = res.status().is_success(); 124 | let headers = res 125 | .headers() 126 | .iter() 127 | .map(|(k, v)| (k.to_string(), v.to_str().unwrap_or("").to_string())) 128 | .collect(); 129 | 130 | let body = match tokio::time::timeout(TIMEOUT_DURATION, res.text()).await { 131 | Ok(body_result) => body_result.map_err(|e| e.to_string())?, 132 | Err(_) => { 133 | return Err(format!( 134 | "Response body read timed out after {} seconds", 135 | TIMEOUT_DURATION.as_secs() 136 | )) 137 | } 138 | }; 139 | 140 | Ok(HttpOkFullResponse { 141 | duration_miliseconds, 142 | status, 143 | status_text, 144 | url, 145 | ok, 146 | headers, 147 | body, 148 | }) 149 | } 150 | 151 | #[tauri::command] 152 | async fn save_with_dialog(content: String, app: tauri::AppHandle) -> Result<(), String> { 153 | let file_dialog: FileDialogBuilder = app.dialog().file(); 154 | 155 | let file_path = tauri::async_runtime::spawn_blocking(move || { 156 | file_dialog 157 | .set_title("Save .httpok file") 158 | .add_filter("HttpOk", &["httpok"]) 159 | .blocking_save_file() 160 | }) 161 | .await 162 | .map_err(|e| e.to_string())?; 163 | 164 | if let Some(path) = file_path.and_then(|f| f.as_path().map(|p| p.to_path_buf())) { 165 | std::fs::write(path, content).map_err(|e| e.to_string())?; 166 | } 167 | 168 | Ok(()) 169 | } 170 | 171 | async fn open_and_read_file(app: tauri::AppHandle) -> Result<(), String> { 172 | let file_dialog: FileDialogBuilder = app.dialog().file(); 173 | 174 | let file_path = tauri::async_runtime::spawn_blocking(move || { 175 | file_dialog 176 | .set_title("Open .httpok file") 177 | .add_filter("HttpOk", &["httpok"]) 178 | .blocking_pick_file() 179 | }) 180 | .await 181 | .map_err(|e| e.to_string())?; 182 | 183 | if let Some(path) = file_path.and_then(|f| f.as_path().map(|p| p.to_path_buf())) { 184 | let content = std::fs::read_to_string(path).map_err(|e| e.to_string())?; 185 | 186 | // Send file content to frontend 187 | if let Some(window) = app.get_webview_window("main") { 188 | window.emit("file-opened", content).unwrap(); 189 | } 190 | } 191 | 192 | Ok(()) 193 | } 194 | 195 | #[cfg_attr(mobile, tauri::mobile_entry_point)] 196 | pub fn run() { 197 | tauri::Builder::default() 198 | .plugin(tauri_plugin_opener::init()) 199 | .plugin(tauri_plugin_dialog::init()) 200 | .setup(|app| { 201 | // Create the "Save" menu item 202 | let save_item = MenuItemBuilder::new("Save .httpok file") 203 | .id("save") 204 | .accelerator("CmdOrCtrl+S") 205 | .build(app)?; 206 | 207 | let open_item = MenuItemBuilder::new("Open .httpok file") 208 | .id("open") 209 | .accelerator("CmdOrCtrl+O") 210 | .build(app)?; 211 | 212 | // Create the "File" submenu and add the "Save" item 213 | let file_menu = SubmenuBuilder::new(app, "File") 214 | .items(&[&open_item, &save_item]) 215 | .build()?; 216 | 217 | // Build the main menu and add the "File" submenu 218 | let menu = MenuBuilder::new(app).items(&[&file_menu]).build()?; 219 | 220 | // Set the menu for the application 221 | app.set_menu(menu)?; 222 | 223 | // Listen for menu events 224 | app.on_menu_event(move |app_handle, event| { 225 | if event.id() == "save" { 226 | if let Some(window) = app_handle.get_webview_window("main") { 227 | let _ = window.emit("menu-save", ()); 228 | } 229 | } 230 | if event.id() == "open" { 231 | let app = app_handle.clone(); 232 | tauri::async_runtime::spawn(async move { 233 | if let Err(e) = open_and_read_file(app).await { 234 | eprintln!("Open failed: {e}"); 235 | } 236 | }); 237 | } 238 | }); 239 | 240 | Ok(()) 241 | }) 242 | .invoke_handler(tauri::generate_handler![ 243 | greet, 244 | fetch_with_full_response, 245 | save_with_dialog 246 | ]) 247 | .run(tauri::generate_context!()) 248 | .expect("error while running tauri application"); 249 | } 250 | -------------------------------------------------------------------------------- /src/routes/+page.svelte: -------------------------------------------------------------------------------- 1 | 594 | 595 |
596 |
597 |
598 |
599 |
600 |
601 | 602 |
603 | 610 |
611 |
612 | 613 | 721 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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 | . --------------------------------------------------------------------------------