├── .prettierrc ├── .gitignore ├── src ├── constants │ └── queryParams.ts ├── types │ ├── internal.ts │ ├── index.ts │ └── mock.ts ├── test │ ├── index.ts │ ├── testConfig.ts │ └── dummy │ │ ├── FileLogSink.ts │ │ ├── dummySource.ts │ │ └── mock1.ts ├── enums │ └── mockServerResponse.ts ├── core │ ├── utils │ │ ├── index.ts │ │ ├── mockProcessor.ts │ │ ├── templating │ │ │ ├── index.ts │ │ │ ├── helpers │ │ │ │ └── requestHelpers.ts │ │ │ └── utils.ts │ │ ├── mockServerResponseHelper.ts │ │ ├── pathMatcher.ts │ │ └── harFormatter.ts │ ├── common │ │ ├── mockHandler.ts │ │ ├── mockSelector.ts │ │ └── mockProcessor.ts │ └── server.ts ├── index.ts ├── services │ └── storageService.ts ├── middlewares │ └── har.ts └── interfaces │ └── config.ts ├── nodemon.json ├── package.json ├── README.md ├── tsconfig.json └── LICENSE /.prettierrc: -------------------------------------------------------------------------------- 1 | {} 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | build/ 3 | .DS_Store 4 | *.log -------------------------------------------------------------------------------- /src/constants/queryParams.ts: -------------------------------------------------------------------------------- 1 | export const RQ_PASSWORD = 'rq_password'; -------------------------------------------------------------------------------- /nodemon.json: -------------------------------------------------------------------------------- 1 | { 2 | "watch": ["src"], 3 | "ext": ".ts,.js", 4 | "ignore": [], 5 | "exec": "npx ts-node ./src/test/index.ts" 6 | } -------------------------------------------------------------------------------- /src/types/internal.ts: -------------------------------------------------------------------------------- 1 | import { RequestMethod } from "."; 2 | 3 | export interface MockContextParams { 4 | urlParams: Record; 5 | method: RequestMethod; 6 | statusCode: number; 7 | headers: Record; 8 | } 9 | -------------------------------------------------------------------------------- /src/test/index.ts: -------------------------------------------------------------------------------- 1 | import MockServer from "../core/server"; 2 | import TestConfig from "./testConfig"; 3 | 4 | const server = new MockServer({ 5 | port: 3001, 6 | pathPrefix: "/mocksv2", 7 | storageConfig: TestConfig 8 | }); 9 | console.debug(server.app); 10 | server.start(); 11 | -------------------------------------------------------------------------------- /src/enums/mockServerResponse.ts: -------------------------------------------------------------------------------- 1 | export enum HttpStatusCode { 2 | OK = 200, 3 | CREATED = 201, 4 | ACCEPTED = 202, 5 | 6 | BAD_REQUEST = 400, 7 | UNAUTHORIZED = 401, 8 | NOT_FOUND = 404, 9 | 10 | INTERNAL_SERVER_ERROR = 500, 11 | NOT_IMPLEMENTED = 501, 12 | BAD_GATEWAY = 502, 13 | } -------------------------------------------------------------------------------- /src/test/testConfig.ts: -------------------------------------------------------------------------------- 1 | 2 | import { Config } from "../interfaces/config"; 3 | import { DummySource } from "./dummy/dummySource"; 4 | import { FileLogSink } from "./dummy/FileLogSink"; 5 | 6 | const testConfig: Config = { 7 | src: new DummySource(), 8 | sink: new FileLogSink(), 9 | } 10 | export default testConfig; 11 | 12 | -------------------------------------------------------------------------------- /src/core/utils/index.ts: -------------------------------------------------------------------------------- 1 | export const cleanupPath = (path: string): string => { 2 | // Stripping front slash. Eg: /users/123/ -> users/123/ 3 | path = path.slice(1); 4 | 5 | // Stripping end slash. Eg: users/123/ -> users/123 6 | if(path.slice(-1) === "/") { 7 | path = path.slice(0, -1); 8 | } 9 | 10 | return path 11 | } -------------------------------------------------------------------------------- /src/core/utils/mockProcessor.ts: -------------------------------------------------------------------------------- 1 | export const validatePassword = ( 2 | savedPassword: string | undefined, 3 | requestPassword: string | undefined 4 | ): boolean => { 5 | if(savedPassword) { 6 | if(!requestPassword || savedPassword !== requestPassword) { 7 | return false; 8 | } 9 | } 10 | return true; 11 | } -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import {Config, ISink, ISource} from "./interfaces/config"; 2 | import MockServer from "./core/server"; 3 | import { Mock as MockSchema, MockMetadata as MockMetadataSchema, Response as MockResponseSchema } from "./types/mock"; 4 | import {Log as MockLog} from "./types"; 5 | export { 6 | MockServer, 7 | Config, ISink, ISource, 8 | MockSchema, 9 | MockMetadataSchema, 10 | MockResponseSchema, 11 | MockLog, 12 | }; 13 | -------------------------------------------------------------------------------- /src/test/dummy/FileLogSink.ts: -------------------------------------------------------------------------------- 1 | import fs from 'fs'; 2 | 3 | import { ISink } from "../../interfaces/config"; 4 | import { Log } from "../../types"; 5 | 6 | 7 | export class FileLogSink implements ISink { 8 | sendLog = async (log: Log): Promise => { 9 | const logLine = `${JSON.stringify(log.HarEntry)}\n`; 10 | fs.writeFile(`${log.mockId}.log`, logLine, { flag: 'a+' }, (err) => { 11 | if(err) { 12 | console.log("Error dumping log to file."); 13 | throw err; 14 | } 15 | }); 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /src/core/utils/templating/index.ts: -------------------------------------------------------------------------------- 1 | import { compile } from "handlebars"; 2 | 3 | import requestHelpers from "./helpers/requestHelpers"; 4 | import { MockContextParams } from "../../../types/internal"; 5 | import { wrapUnexpectedTemplateCaptures } from "./utils"; 6 | 7 | 8 | export const renderTemplate = (template: string, params: MockContextParams): string => { 9 | const allHelpers = {...requestHelpers(params)} 10 | const wrappedTemplate = wrapUnexpectedTemplateCaptures(template, allHelpers); 11 | const hbsTemplate = compile(wrappedTemplate); 12 | return hbsTemplate(params, { 13 | helpers: allHelpers 14 | }); 15 | }; -------------------------------------------------------------------------------- /src/types/index.ts: -------------------------------------------------------------------------------- 1 | import type { Entry } from "har-format"; 2 | import { HttpStatusCode } from "../enums/mockServerResponse"; 3 | 4 | export enum RequestMethod { 5 | GET = "GET", 6 | POST = "POST", 7 | PUT = "PUT", 8 | PATCH = "PATCH", 9 | DELETE = "DELETE", 10 | HEAD = "HEAD", 11 | OPTIONS = "OPTIONS" 12 | } 13 | 14 | export enum Mode { 15 | FIREBASE = "FIREBASE", 16 | } 17 | 18 | export interface MockServerResponse { 19 | body: string, 20 | statusCode: HttpStatusCode, 21 | headers: { [key: string]: string } 22 | metadata?: { mockId: string } 23 | } 24 | 25 | export interface Log { 26 | mockId: string; 27 | HarEntry: Partial; 28 | } -------------------------------------------------------------------------------- /src/test/dummy/dummySource.ts: -------------------------------------------------------------------------------- 1 | import { dummyMock1, dummyMock2, dummyMock3, dummyMock4, getSelectorMap } from "./mock1"; 2 | import { ISource } from "../../interfaces/config"; 3 | 4 | export class DummySource implements ISource { 5 | getMockSelectorMap = (kwargs?: any) => { 6 | return getSelectorMap(); 7 | }; 8 | 9 | getMock = (id: string, kwargs?: any) => { 10 | if(id === "1") { 11 | return dummyMock1; 12 | } 13 | else if(id === "2") { 14 | return dummyMock2; 15 | } 16 | else if(id === "3") { 17 | return dummyMock3; 18 | } 19 | else if(id === "4") { 20 | return dummyMock4; 21 | } 22 | 23 | return null; 24 | } 25 | } -------------------------------------------------------------------------------- /src/types/mock.ts: -------------------------------------------------------------------------------- 1 | import { RequestMethod } from "."; 2 | 3 | // TODO: Convert into classes later on 4 | export interface Mock extends MockMetadata { 5 | responses: Response[]; // Right now we are keeping only 1 response 6 | } 7 | 8 | // Useful when fetching list of mocks. Saves network bandwith 9 | export interface MockMetadata { 10 | id: string; 11 | name: string; 12 | desc?: string; 13 | method: RequestMethod; 14 | endpoint: string; 15 | ownerId?: string; 16 | createdTs?: number; 17 | updatedTs?: number; 18 | password?: string; 19 | } 20 | 21 | export interface Response { 22 | id: string; 23 | desc?: string; 24 | latency?: number; 25 | statusCode: number; // TODO: Change this to list of acceptable status codes 26 | headers: { [key: string]: string }; 27 | body: string; 28 | filePath?: string; 29 | // rules: [] 30 | } 31 | -------------------------------------------------------------------------------- /src/core/utils/mockServerResponseHelper.ts: -------------------------------------------------------------------------------- 1 | import { HttpStatusCode } from "../../enums/mockServerResponse"; 2 | import { MockServerResponse } from "../../types"; 3 | 4 | export const getServerMockResponse = (statusCode: HttpStatusCode): MockServerResponse => { 5 | switch(statusCode) { 6 | case HttpStatusCode.NOT_FOUND: 7 | return { 8 | statusCode, 9 | headers: {}, 10 | body: "Mock Not Found", 11 | } 12 | case HttpStatusCode.UNAUTHORIZED: 13 | return { 14 | statusCode, 15 | headers: {}, 16 | body: "Unauthorized, please check if you have access to this route or append a x-password query-param to your URL", 17 | } 18 | } 19 | 20 | return { 21 | statusCode, 22 | headers: {}, 23 | body: "", 24 | }; 25 | } -------------------------------------------------------------------------------- /src/core/utils/templating/helpers/requestHelpers.ts: -------------------------------------------------------------------------------- 1 | import { MockContextParams } from "../../../../types/internal"; 2 | 3 | const requestHelpers = (params: MockContextParams) => { 4 | const helpers = { 5 | urlParam: (param: string) => params.urlParams[param], 6 | method: () => params.method, 7 | statusCode: () => params.statusCode, 8 | header: (param: string, defaultValue: string = '') => { 9 | // handlebars passes object when no value is passed 10 | // { 11 | // lookupProperty: [Function: lookupProperty], 12 | // name: 'header', 13 | // hash: {}, 14 | // data: { root: [Object] }, 15 | // loc: { start: [Object], end: [Object] } 16 | // } 17 | if(typeof defaultValue === 'object') { 18 | defaultValue = ''; 19 | } 20 | 21 | if(typeof param === 'object') { 22 | return defaultValue 23 | } 24 | 25 | return params.headers[param?.toLowerCase()] || defaultValue; 26 | }, 27 | }; 28 | return helpers; 29 | }; 30 | 31 | export default requestHelpers; 32 | -------------------------------------------------------------------------------- /src/services/storageService.ts: -------------------------------------------------------------------------------- 1 | import {Config, ISink, ISource} from "../interfaces/config"; 2 | import { Log } from "../types"; 3 | 4 | class StorageService { 5 | source: ISource | null = null; 6 | sink: ISink | null = null; 7 | 8 | constructor(config?: Config) { 9 | this.source = config?.src || null; 10 | this.sink = config?.sink || null; 11 | } 12 | 13 | // TODO: This should be set when starting the mock server 14 | setConfig = (config: Config) => { 15 | this.source = config.src || null; 16 | this.sink = config.sink || null; 17 | } 18 | 19 | getMockSelectorMap = async (kwargs ?: any): Promise => { 20 | return this.source?.getMockSelectorMap(kwargs); 21 | }; 22 | 23 | getMock = async (id: string, kwargs?: any): Promise => { 24 | return this.source?.getMock(id, kwargs); 25 | } 26 | 27 | storeLog = async (log: Log): Promise => { 28 | await this.sink?.sendLog(log); 29 | } 30 | } 31 | 32 | const storageService = new StorageService(); 33 | export default storageService; -------------------------------------------------------------------------------- /src/core/utils/templating/utils.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * if match is a string like {{unknownHelper arg1 arg2}} 3 | * it will add `\\` to its prefix, signaling handlebars should ignore it 4 | * 5 | * https://handlebarsjs.com/guide/expressions.html#escaping-handlebars-expressions 6 | */ 7 | function escapeMatchFromHandlebars(match: string) { 8 | return match.replace(/({{)/g, "\\$1"); 9 | } 10 | 11 | export function wrapUnexpectedTemplateCaptures( 12 | template: string, 13 | allHelpers: Record 14 | ) { 15 | const helperNames = Object.keys(allHelpers); 16 | return template.replace( 17 | // NOTE: breaks when "{{ }}" does not contain helper name and it comes in start 18 | // example: "{id: {{ }}, name: {{ urlParam \'name\' }} }" 19 | /{{\s*(\S+)(.*?)}}/g, 20 | (completeMatch, firstMatchedGroup) => { 21 | const matchContainsKnownHelper = helperNames.some((helperName) => { 22 | return firstMatchedGroup.trim() === helperName; 23 | }); 24 | 25 | if (!matchContainsKnownHelper) { 26 | return escapeMatchFromHandlebars(completeMatch); 27 | } else { 28 | return completeMatch; 29 | } 30 | } 31 | ); 32 | } 33 | -------------------------------------------------------------------------------- /src/middlewares/har.ts: -------------------------------------------------------------------------------- 1 | import type { Entry } from "har-format"; 2 | import { NextFunction, Request, Response } from "express"; 3 | import storageService from "../services/storageService"; 4 | import { buildHarRequest, buildHarResponse } from "../core/utils/harFormatter"; 5 | 6 | 7 | export const HarMiddleware = (req: Request, res: Response, next: NextFunction) => { 8 | const originalSend = res.send; 9 | 10 | const requestStartTime = new Date(); 11 | const requestStartTimeStamp: string = requestStartTime.toISOString(); 12 | 13 | let responseBody: string; 14 | 15 | res.send = function (body) { 16 | responseBody = body; 17 | return originalSend.call(this, body); 18 | }; 19 | 20 | res.once('finish', () => { 21 | const HarEntry: Partial = { 22 | time: Date.now() - requestStartTime.getTime(), 23 | startedDateTime: requestStartTimeStamp, 24 | request: buildHarRequest(req), 25 | response: buildHarResponse(res, { body: responseBody }), 26 | } 27 | 28 | storageService.storeLog({ mockId: res.locals.rq_metadata.mockId, HarEntry, }) 29 | }); 30 | 31 | next(); 32 | }; -------------------------------------------------------------------------------- /src/interfaces/config.ts: -------------------------------------------------------------------------------- 1 | 2 | 3 | import { Log } from "../types"; 4 | 5 | export class ISink { 6 | /** 7 | * specify how and where to store logs from mock execution 8 | */ 9 | sendLog = (log: Log): Promise => { 10 | return Promise.resolve(); 11 | } 12 | } 13 | 14 | 15 | import { Mock } from "../types/mock" 16 | 17 | export class ISource { 18 | /** 19 | * 20 | * @param id Mock Id 21 | * @param kwargs Contains extra val required for storage fetching. Eg. uid in case of firebaseStorageService 22 | * @returns Return the Mock definition 23 | */ 24 | getMock = (id: string, kwargs?: any): Mock | null => {return null} 25 | 26 | 27 | /** 28 | * Get the mock selector map. Used to easily select the mock to apply. 29 | * - Firebase stores this in a doc 30 | * - Local JSON will process and return this in realtime. 31 | * 32 | * { 33 | * mockId: { 34 | * route: "", 35 | * method: "", 36 | * } 37 | * } 38 | */ 39 | getMockSelectorMap = (kwargs?: any): any => {return {}} 40 | } 41 | 42 | 43 | export interface Config { 44 | src: ISource; 45 | sink?: ISink; 46 | } -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@requestly/mock-server", 3 | "version": "0.3.3", 4 | "description": "- Methods: GET, POST, PUT, OPTIONS - Description - Endpoint (can be full path) (/api/v1/users) - Multiple Responses - Shuffle Response - Sequential Response - Rules in Response - Status (Any status code 2xx, 4xx) - Latency - Body - Templating - Faker js - Headers", 5 | "main": "build/index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1", 8 | "start": "npm run build && node build/test/index.js", 9 | "start:dev": "npx nodemon", 10 | "build": "rimraf ./build && tsc", 11 | "prepublish": "npm run build" 12 | }, 13 | "author": "", 14 | "license": "ISC", 15 | "devDependencies": { 16 | "@types/cors": "^2.8.13", 17 | "@types/express": "^4.17.14", 18 | "@types/node": "^18.11.11", 19 | "@types/path-to-regexp": "^1.7.0", 20 | "nodemon": "^3.1.0", 21 | "rimraf": "^3.0.2", 22 | "ts-node": "^10.9.1", 23 | "typescript": "^4.9.4" 24 | }, 25 | "dependencies": { 26 | "@types/har-format": "^1.2.14", 27 | "cors": "^2.8.5", 28 | "express": "^4.20.0", 29 | "handlebars": "^4.7.8", 30 | "path-to-regexp": "^0.1.7" 31 | }, 32 | "files": [ 33 | "build" 34 | ] 35 | } 36 | -------------------------------------------------------------------------------- /src/core/common/mockHandler.ts: -------------------------------------------------------------------------------- 1 | import { Request } from "express"; 2 | import { MockServerResponse, RequestMethod } from "../../types"; 3 | import MockProcessor from "./mockProcessor"; 4 | import MockSelector from "./mockSelector"; 5 | import { getServerMockResponse } from "../utils/mockServerResponseHelper"; 6 | import { HttpStatusCode } from "../../enums/mockServerResponse"; 7 | import { RQ_PASSWORD } from "../../constants/queryParams"; 8 | 9 | class MockServerHandler { 10 | static handleEndpoint = async (req: Request): Promise => { 11 | let endpoint = req.path; 12 | const method = req.method as RequestMethod; 13 | const queryParams = req.query || {}; 14 | 15 | const kwargs = { 16 | queryParams: queryParams 17 | } 18 | 19 | const mockData = await MockSelector.selectMock(endpoint, method, kwargs); 20 | 21 | if(mockData) { 22 | // console.debug("[Debug] Mock Selected with data", mockData); 23 | const mockResponse: MockServerResponse = await MockProcessor.process( 24 | mockData, 25 | req, 26 | queryParams[RQ_PASSWORD] as string, 27 | ); 28 | return { 29 | ...mockResponse, 30 | metadata: { mockId: mockData.id }, 31 | } 32 | } 33 | 34 | console.debug("[Debug] No Mock Selected"); 35 | return getServerMockResponse(HttpStatusCode.NOT_FOUND); 36 | } 37 | } 38 | 39 | export default MockServerHandler; 40 | -------------------------------------------------------------------------------- /src/core/utils/pathMatcher.ts: -------------------------------------------------------------------------------- 1 | // @ts-ignore 2 | import pathToRegexp from "path-to-regexp"; 3 | 4 | interface PathMatcherResult { 5 | success: boolean; 6 | params: Record; 7 | } 8 | 9 | /** 10 | * Common method that gets called 11 | * - selecting mock 12 | * - processing mock to find out path params 13 | * @param pattern Pattern To match (endpoint defined while creating mock) 14 | * @param path Actual Url that got hit 15 | * @return If pattern matches the url, then return the variables as kwargs, else return null 16 | */ 17 | const pathMatcher = (pattern: string, path: string): PathMatcherResult => { 18 | const result: any = { 19 | success: false, 20 | params: {}, 21 | } 22 | 23 | let keys: any[] =[]; 24 | const regexp = pathToRegexp(pattern, keys); 25 | console.log(`regexp: ${regexp}`); 26 | console.log("keys: ", keys); 27 | 28 | if(regexp.test(path)) { 29 | const matches = regexp.exec(path); 30 | console.log("MATCHED results: ", matches); 31 | result.params = convertMatchKeysToDict(keys, matches); 32 | result.success = true; 33 | } 34 | 35 | console.log("pathMatcher result: ", result); 36 | return result; 37 | } 38 | 39 | /** 40 | * Uses the keys from pathToRegexp and regex results to create finalParams 41 | */ 42 | const convertMatchKeysToDict = (keys: any[] = [], result: any) => { 43 | const params: Record= {}; 44 | keys.map((key: Record, i: number) => { 45 | params[key.name] = result[i+1]; 46 | }) 47 | return params; 48 | } 49 | 50 | export default pathMatcher; -------------------------------------------------------------------------------- /src/core/common/mockSelector.ts: -------------------------------------------------------------------------------- 1 | import storageService from "../../services/storageService"; 2 | import { RequestMethod } from "../../types"; 3 | import { Mock } from "../../types/mock"; 4 | import pathMatcher from "../utils/pathMatcher"; 5 | 6 | 7 | class MockSelector { 8 | // Selects and return the first mock which matches the current endpoint 9 | static selectMock = async (endpoint: string, method: RequestMethod, kwargs: any): Promise=> { 10 | console.debug("[MockSelector]", endpoint, method, kwargs) 11 | 12 | const mockSelectorMap: any = await storageService.getMockSelectorMap(kwargs) || {}; 13 | let mockId = null; 14 | 15 | mockId = Object.keys(mockSelectorMap).find((elem) => { 16 | return this.compareSelector(mockSelectorMap[elem], endpoint, method); 17 | }) 18 | 19 | if(mockId) { 20 | console.debug(`[Debug][mockSelector] Mock Selected ${mockId}`); 21 | const mockData = await storageService.getMock(mockId, kwargs); 22 | return mockData; 23 | } 24 | 25 | console.debug(`[Debug][mockSelector] No Mock Selected`); 26 | 27 | return null; 28 | } 29 | 30 | // Return whether the endpoint matches the selector for a mock or not 31 | static compareSelector = (selector: any, endpoint: string, method: RequestMethod): Boolean => { 32 | const methodMatched = selector.method === method; 33 | const urlMatched = pathMatcher(selector.endpoint, endpoint).success || false; 34 | 35 | if(methodMatched && urlMatched) { 36 | return true; 37 | } 38 | 39 | return false; 40 | } 41 | } 42 | 43 | export default MockSelector; 44 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # requestly-mock-server 2 | 3 | This Repo contains the core express server [@requestly/mock-server](https://www.npmjs.com/package/@requestly/mock-server) package which powers Requestly's Cloud Mock Server. 4 | 5 | ## Development 6 | ### Install Dependencies 7 | ``` sh 8 | npm i 9 | ``` 10 | 11 | ### Start Server 12 | ``` sh 13 | npm start:dev 14 | ``` 15 | 16 | ## Usage with firebase-functions 17 | 18 | ### Install 19 | ``` sh 20 | npm i @requestly/mock-server 21 | ``` 22 | 23 | ### Setup 24 | ``` javascript 25 | import * as functions from 'firebase-functions'; 26 | import { MockServer } from '@requestly/mock-server'; 27 | import firebaseConfig from '../firebaseConfig'; 28 | 29 | const startMockServer = () => { 30 | const expressApp = new MockServer(3000, firebaseConfig, '/api/mockv2').app; 31 | 32 | return functions.runWith({ minInstances: isProdEnv() ? 1 : 0 }).https.onRequest(expressApp); 33 | }; 34 | 35 | export const handleMockRequest = startMockServer(); 36 | ``` 37 | 38 | ``` javascript 39 | class FirebaseConfig implements IConfig { 40 | getMockSelectorMap = (kwargs?: any) => { 41 | /** 42 | * Fetch and return mockSelectorMap from firestore 43 | * { 44 | * mockId: { 45 | * route: "", 46 | * method: "", 47 | * } 48 | * } 49 | */ 50 | }; 51 | 52 | getMock = (id: string, kwargs?: any) => { 53 | /** 54 | * Fetch mock details from firestore 55 | */ 56 | } 57 | 58 | storeLog? = (log: Log) => { 59 | /** 60 | * Store log in cloud storages 61 | */ 62 | } 63 | } 64 | 65 | const firebaseConfig = new FirebaseConfig(); 66 | export default firebaseConfig; 67 | ``` 68 | 69 | 70 | 71 | ## Requestly Cloud Mock Server Architechture 72 | ![image](https://github.com/requestly/requestly-mock-server/assets/16779465/277fbe21-45ad-45d2-ab65-64ea362ce17a) 73 | 74 | **STEPS** 75 | 1. Request coming from GET `https://username.requestly.dev/users` 76 | 2. Firebase Function passes the request to @requestly/mock-server 77 | 3. @requestly/mock-server - MockSelector 78 | a. Fetches all the available mocks using `IConfig.getMockSelectorMap()` (Firestore in case of Requestly) 79 | b. Select mock if any endpoint+method matches the incoming request (GET /users) 80 | c. Fetch Mock using `IConfig.getMock(mockId)` and pass it to MockProcessor 81 | 4. @requestly/mock-server - MockProcessor 82 | a. Process Mock - Response Rendering 83 | b. Return Response 84 | -------------------------------------------------------------------------------- /src/core/common/mockProcessor.ts: -------------------------------------------------------------------------------- 1 | import { Request } from "express"; 2 | import { HttpStatusCode } from "../../enums/mockServerResponse"; 3 | import { MockServerResponse, RequestMethod } from "../../types"; 4 | import { MockContextParams } from "../../types/internal"; 5 | import { Mock, MockMetadata, Response } from "../../types/mock"; 6 | import { validatePassword } from "../utils/mockProcessor"; 7 | import { getServerMockResponse } from "../utils/mockServerResponseHelper"; 8 | import pathMatcher from "../utils/pathMatcher"; 9 | import { renderTemplate } from "../utils/templating"; 10 | 11 | class MockProcessor { 12 | static process = async ( 13 | mockData: Mock, 14 | request: Request, 15 | password?: string 16 | ): Promise => { 17 | if (!validatePassword(mockData.password, password)) { 18 | return getServerMockResponse(HttpStatusCode.UNAUTHORIZED); 19 | } 20 | 21 | return this.renderMockServerResponse(mockData, request); 22 | }; 23 | 24 | static renderMockServerResponse = async ( 25 | mockData: Mock, 26 | request: Request, 27 | ): Promise => { 28 | // TODO: Right now we select only first response. 29 | // In future this needs to be selected on the basis of rules 30 | const responseTemplate: Response = mockData.responses[0]; 31 | 32 | const urlParams = pathMatcher(mockData.endpoint, request.path).params || {}; 33 | const contextParams: MockContextParams = { 34 | method: request.method as RequestMethod, 35 | statusCode: responseTemplate.statusCode, 36 | urlParams, 37 | headers: request.headers as Record || {}, 38 | }; 39 | 40 | console.log({ contextParams }); 41 | 42 | const mockServerResponse: MockServerResponse = { 43 | statusCode: this.renderStatusCode(responseTemplate), 44 | headers: this.renderHeaders(responseTemplate), 45 | body: this.renderBody(responseTemplate, contextParams), 46 | }; 47 | 48 | await this.addDelay(responseTemplate.latency); 49 | return mockServerResponse; 50 | }; 51 | 52 | static renderStatusCode = (responseTemplate: Response) => { 53 | return responseTemplate.statusCode; 54 | }; 55 | 56 | // TODO: Pass extra params here required for rendering 57 | // TODO: Do rendering of header here 58 | static renderHeaders = (responseTemplate: Response) => { 59 | const headers: any = {}; 60 | Object.keys(responseTemplate.headers).map((key) => { 61 | headers[key] = responseTemplate.headers[key]; 62 | }); 63 | return headers; 64 | }; 65 | 66 | // TODO: Pass extra params here required for rendering 67 | static renderBody = ( 68 | responseTemplate: Response, 69 | mockContextParams: MockContextParams 70 | ) => { 71 | let finalBody = null; 72 | let bodyTemplate: string = responseTemplate.body; 73 | finalBody = renderTemplate(bodyTemplate, mockContextParams); 74 | return finalBody; 75 | }; 76 | 77 | // Time in ms 78 | // TODO: Write logic for delay here 79 | static addDelay = async (delay: number = 0) => { 80 | console.debug(`[Debug] Adding delay of ${delay}`); 81 | return new Promise((resolve) => setTimeout(resolve, delay)); 82 | }; 83 | } 84 | 85 | export default MockProcessor; 86 | -------------------------------------------------------------------------------- /src/test/dummy/mock1.ts: -------------------------------------------------------------------------------- 1 | import { RequestMethod } from "../../types"; 2 | import { Mock } from "../../types/mock"; 3 | 4 | export const dummyMock1: Mock = { 5 | id: "1", 6 | name: "mock1", 7 | desc: "Mock 1", 8 | ownerId: "1", 9 | method: RequestMethod.POST, 10 | endpoint: "abcd/:userId/:name", 11 | responses: [ 12 | { 13 | id: "1", 14 | desc: "Mock 1 Response 1", 15 | latency: 1000, 16 | statusCode: 201, 17 | headers: { 18 | foo: "bar", 19 | "content-type": "application/json", 20 | }, 21 | body: '{"Hello":"There","mockId":"1", "statusCode": {{ statusCode }}, "method": "{{ method }}", "urlParams": "{{ urlParam \'userId\' }}", "header": "{{ header \'userid\' \'test\' }}" }}', 22 | }, 23 | ], 24 | }; 25 | 26 | export const dummyMock2: Mock = { 27 | id: "2", 28 | name: "mock2", 29 | desc: "Mock 2", 30 | ownerId: "2", 31 | method: RequestMethod.GET, 32 | endpoint: "users2", 33 | responses: [ 34 | { 35 | id: "1", 36 | desc: "Mock 2 Response 1", 37 | latency: 0, 38 | statusCode: 200, 39 | headers: { 40 | foo: "bar", 41 | "content-type": "application/json", 42 | }, 43 | body: '{"Hello":"There","mockId":"2"}', 44 | }, 45 | ], 46 | }; 47 | 48 | export const dummyMock3: Mock = { 49 | id: "3", 50 | name: "mock3", 51 | desc: "Mock 3 : Password protected", 52 | ownerId: "3", 53 | method: RequestMethod.GET, 54 | endpoint: "users3", 55 | password: "1234", 56 | responses: [ 57 | { 58 | id: "1", 59 | desc: "Mock 3 Response 1", 60 | latency: 0, 61 | statusCode: 200, 62 | headers: { 63 | foo: "bar", 64 | "content-type": "application/json", 65 | }, 66 | body: '{"Hello":"There","mockId":"3"}', 67 | }, 68 | ], 69 | }; 70 | 71 | export const dummyMock4: Mock = { 72 | id: "4", 73 | name: "mock4", 74 | desc: "Mock 4 : Password protected", 75 | ownerId: "4", 76 | method: RequestMethod.GET, 77 | endpoint: "users4/:id/:name", 78 | responses: [ 79 | { 80 | id: "1", 81 | desc: "Mock 4 Response 1", 82 | latency: 0, 83 | statusCode: 200, 84 | headers: { 85 | "x-foo": "bar", 86 | "content-type": "text/plain", 87 | }, 88 | body: `the id is {{urlParam 'id'}} . the url is {{url}} . not passing param to url param {{urlParam}}. Content type is {{header 'Content-Type'}}. giberish ahead: {{random values}} {{}} {{color: "something"}} {{url 'http://localhost:3000'}} {{urlParam 'id'}} {{ color: "red", display: flex}}`, 89 | }, 90 | ], 91 | }; 92 | 93 | export const getSelectorMap = (): any => { 94 | let selectorMap: any = {}; 95 | selectorMap[dummyMock1.id] = { 96 | method: dummyMock1.method, 97 | endpoint: dummyMock1.endpoint, 98 | }; 99 | 100 | selectorMap[dummyMock2.id] = { 101 | method: dummyMock2.method, 102 | endpoint: dummyMock2.endpoint, 103 | }; 104 | 105 | selectorMap[dummyMock3.id] = { 106 | method: dummyMock3.method, 107 | endpoint: dummyMock3.endpoint, 108 | }; 109 | 110 | selectorMap[dummyMock4.id] = { 111 | method: dummyMock4.method, 112 | endpoint: dummyMock4.endpoint, 113 | }; 114 | 115 | return selectorMap; 116 | }; 117 | -------------------------------------------------------------------------------- /src/core/server.ts: -------------------------------------------------------------------------------- 1 | import express, { Request, Response, Express } from "express"; 2 | import cors from "cors"; 3 | 4 | import MockServerHandler from "./common/mockHandler"; 5 | import { Config } from "../interfaces/config"; 6 | import storageService from "../services/storageService"; 7 | import { MockServerResponse } from "../types"; 8 | import { HarMiddleware } from "../middlewares/har"; 9 | import { cleanupPath } from "./utils"; 10 | 11 | interface MockServerOptions { 12 | port: number; 13 | pathPrefix: string; 14 | storageConfig: Config; 15 | } 16 | 17 | /* To make the constructor options optional except for storageConfig */ 18 | type MockServerConstructorOptions = Pick & Partial; 19 | 20 | class MockServer { 21 | serverOptions: MockServerOptions; 22 | app: Express 23 | 24 | constructor (options: MockServerConstructorOptions) { 25 | this.serverOptions = { 26 | storageConfig: options.storageConfig, 27 | port: options.port ?? 3000, 28 | pathPrefix: options.pathPrefix ?? "", 29 | }; 30 | 31 | 32 | this.app = this.setup(); 33 | } 34 | 35 | start = () => { 36 | this.app.listen(this.serverOptions.port, () => { 37 | console.log(`Mock Server Listening on port ${this.serverOptions.port}`); 38 | }) 39 | } 40 | 41 | setup = (): Express => { 42 | this.initStorageService(); 43 | 44 | const app = express(); 45 | 46 | // Use middleware to parse `application/json` and `application/x-www-form-urlencoded` body data 47 | app.use(express.json()); 48 | app.use(express.urlencoded({ extended: true })); 49 | 50 | app.use(HarMiddleware); 51 | 52 | app.use((_, res, next) => { 53 | res.set({ 54 | "cache-control": "no-store", 55 | "X-Robots-Tag": "noindex", 56 | }); 57 | next(); 58 | }); 59 | 60 | app.use(cors({ 61 | origin: true, 62 | exposedHeaders: "*", 63 | methods: "*", 64 | credentials: true, 65 | preflightContinue: false, 66 | optionsSuccessStatus: 200, 67 | })); 68 | 69 | // pathPrefix to handle /mockv2 prefix in cloud functions 70 | const regex = new RegExp(`${this.serverOptions.pathPrefix}\/(.+)`); 71 | app.all(regex, async (req: Request, res: Response) => { 72 | console.log(`Initial Request`); 73 | console.log(`Path: ${req.path}`); 74 | console.log(`Query Params: ${JSON.stringify(req.query)}`); 75 | 76 | // Stripping URL prefix 77 | if(req.path.indexOf(this.serverOptions.pathPrefix) === 0) { 78 | console.log(`Stripping pathPrefix: ${this.serverOptions.pathPrefix}`); 79 | Object.defineProperty(req, 'path', { 80 | value: cleanupPath(req.path.slice(this.serverOptions.pathPrefix.length)), 81 | writable: true 82 | }); 83 | console.log(`Path after stripping prefix and cleanup: ${req.path}`); 84 | } 85 | 86 | const mockResponse: MockServerResponse = await MockServerHandler.handleEndpoint(req); 87 | console.debug("[Debug] Final Mock Response", mockResponse); 88 | 89 | res.locals.rq_metadata = mockResponse.metadata; 90 | return res.status(mockResponse.statusCode).set(mockResponse.headers).send(mockResponse.body); 91 | }); 92 | 93 | return app; 94 | } 95 | 96 | initStorageService = () => { 97 | storageService.setConfig(this.serverOptions.storageConfig); 98 | } 99 | } 100 | 101 | export default MockServer; 102 | -------------------------------------------------------------------------------- /src/core/utils/harFormatter.ts: -------------------------------------------------------------------------------- 1 | import type { 2 | Request as HarRequest, 3 | Response as HarResponse, 4 | Header as HarHeader, 5 | } from "har-format"; 6 | import { IncomingHttpHeaders, OutgoingHttpHeaders } from "http"; 7 | import { Request, Response } from "express"; 8 | import { RequestMethod } from "../../types"; 9 | 10 | export const getHarHeaders = (headers: IncomingHttpHeaders | OutgoingHttpHeaders): HarHeader[] => { 11 | const harHeaders: HarHeader[] = []; 12 | 13 | for (const headerName in headers) { 14 | const headerValue = headers[headerName]; 15 | // Header values can be string | string[] according to Node.js typings, 16 | // but HAR format requires a string, so we need to handle this. 17 | if (headerValue) { 18 | const value = Array.isArray(headerValue) ? headerValue.join('; ') : headerValue; 19 | harHeaders.push({ name: headerName, value: value.toString() }); 20 | } 21 | } 22 | 23 | return harHeaders; 24 | }; 25 | 26 | export const getPostData = (req: Request): HarRequest['postData'] => { 27 | if ([RequestMethod.POST, RequestMethod.PUT, RequestMethod.PATCH].includes(req.method as RequestMethod)) { 28 | const postData: any = { 29 | mimeType: req.get('Content-Type') || 'application/json', 30 | text: '', 31 | params: [], 32 | }; 33 | 34 | // When the body is URL-encoded, the body should be converted into params 35 | if (postData.mimeType === 'application/x-www-form-urlencoded' && typeof req.body === 'object') { 36 | postData.params = Object.keys(req.body).map(key => ({ 37 | name: key, 38 | value: req.body[key], 39 | })); 40 | } else if (req.body) { 41 | try { 42 | postData.text = typeof req.body === 'string' ? req.body : JSON.stringify(req.body); 43 | } catch (error) { 44 | postData.text = ""; 45 | } 46 | } 47 | 48 | return postData; 49 | } 50 | return undefined; 51 | } 52 | 53 | export const getHarRequestQueryString = (req: Request): HarRequest['queryString'] => { 54 | const queryObject: Request['query'] = req.query; 55 | 56 | const queryString: HarRequest['queryString'] = []; 57 | 58 | for (const [name, value] of Object.entries(queryObject)) { 59 | if (Array.isArray(value)) { 60 | value.forEach(val => queryString.push({ name, value: val as string })); 61 | } else { 62 | queryString.push({ name, value: value as string }); 63 | } 64 | } 65 | 66 | return queryString; 67 | } 68 | 69 | export const buildHarRequest = (req: Request): HarRequest => { 70 | const requestData = getPostData(req) 71 | return { 72 | method: req.method, 73 | url: req.url, 74 | httpVersion: req.httpVersion, 75 | cookies: [], 76 | headers: getHarHeaders(req.headers), 77 | queryString: getHarRequestQueryString(req), 78 | postData: requestData, 79 | headersSize: -1, // not calculating for now 80 | bodySize: requestData ? Buffer.byteLength(requestData.text!) : -1, 81 | } 82 | }; 83 | 84 | export const buildHarResponse = (res: Response, metadata?: any): HarResponse => { 85 | const { body } = metadata; 86 | const bodySize = body ? Buffer.byteLength(JSON.stringify(body || {})) : -1; 87 | return { 88 | status: res.statusCode, 89 | statusText: res.statusMessage, 90 | httpVersion: res.req.httpVersion, 91 | cookies: [], 92 | headers: getHarHeaders(res.getHeaders()), 93 | content: { 94 | size: bodySize, // same as bodySize since serving uncompressed 95 | mimeType: res.get('Content-Type') || 'application/json', 96 | text: JSON.stringify(body), 97 | }, 98 | redirectURL: '', // todo: implement when we integrate rules to mocks 99 | headersSize: -1, // not calculating for now 100 | bodySize, 101 | } 102 | }; -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | /* Visit https://aka.ms/tsconfig to read more about this file */ 4 | 5 | /* Projects */ 6 | // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ 7 | // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ 8 | // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ 9 | // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ 10 | // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ 11 | // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ 12 | 13 | /* Language and Environment */ 14 | "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ 15 | "lib": ["es6"], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ 16 | // "jsx": "preserve", /* Specify what JSX code is generated. */ 17 | // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ 18 | // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ 19 | // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ 20 | // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ 21 | // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ 22 | // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ 23 | // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ 24 | // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ 25 | // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ 26 | 27 | /* Modules */ 28 | "module": "commonjs", /* Specify what module code is generated. */ 29 | "rootDir": "src", /* Specify the root folder within your source files. */ 30 | // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ 31 | // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ 32 | // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ 33 | // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ 34 | // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ 35 | // "types": [], /* Specify type package names to be included without being referenced in a source file. */ 36 | // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ 37 | // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ 38 | "resolveJsonModule": true, /* Enable importing .json files. */ 39 | // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ 40 | 41 | /* JavaScript Support */ 42 | "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ 43 | // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ 44 | // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ 45 | 46 | /* Emit */ 47 | "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ 48 | // "declarationMap": true, /* Create sourcemaps for d.ts files. */ 49 | // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ 50 | // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ 51 | // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ 52 | "outDir": "build", /* Specify an output folder for all emitted files. */ 53 | // "removeComments": true, /* Disable emitting comments. */ 54 | // "noEmit": true, /* Disable emitting files from a compilation. */ 55 | // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ 56 | // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ 57 | // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ 58 | // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ 59 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ 60 | // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ 61 | // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ 62 | // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ 63 | // "newLine": "crlf", /* Set the newline character for emitting files. */ 64 | // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ 65 | // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ 66 | // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ 67 | // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ 68 | // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ 69 | // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ 70 | 71 | /* Interop Constraints */ 72 | // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ 73 | // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ 74 | "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ 75 | // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ 76 | "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ 77 | 78 | /* Type Checking */ 79 | "strict": true, /* Enable all strict type-checking options. */ 80 | "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ 81 | // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ 82 | // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ 83 | // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ 84 | // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ 85 | // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ 86 | // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ 87 | // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ 88 | // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ 89 | // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ 90 | // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ 91 | // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ 92 | // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ 93 | // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ 94 | // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ 95 | // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ 96 | // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ 97 | // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ 98 | 99 | /* Completeness */ 100 | // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ 101 | "skipLibCheck": true /* Skip type checking all .d.ts files. */ 102 | } 103 | } 104 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------