├── .gitignore ├── .ide_helper.php ├── .github └── workflows │ ├── exclude.txt │ ├── signrelease.yml │ └── sign.sh ├── package.json ├── page.helloworld.php ├── views ├── bootnav.php ├── grid.php ├── default.php └── form.php ├── assets ├── js │ └── helloworld.js └── README.md ├── Backup.php ├── .vscode ├── extensions.json └── settings.json ├── Restore.php ├── module.xml ├── Console └── Helloworld.class.php ├── README.md ├── Helloworld.class.php └── LICENSE.md /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | node/logs/install.log 3 | assets/less/cache 4 | yarn.lock 5 | -------------------------------------------------------------------------------- /.ide_helper.php: -------------------------------------------------------------------------------- 1 | Helloworld->showPage(); 4 | -------------------------------------------------------------------------------- /views/bootnav.php: -------------------------------------------------------------------------------- 1 |   2 |   -------------------------------------------------------------------------------- /assets/js/helloworld.js: -------------------------------------------------------------------------------- 1 | //This format's the action column 2 | function linkFormat(value){ 3 | var html = ` `; 4 | html += ``; 5 | return html; 6 | } -------------------------------------------------------------------------------- /views/grid.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 |
-------------------------------------------------------------------------------- /Backup.php: -------------------------------------------------------------------------------- 1 | FreePBX->Helloworld->getAllids(); 7 | $kvstoreids[] = 'noid'; 8 | $settings = []; 9 | foreach ($kvstoreids as $value) { 10 | $settings[$value] = $this->FreePBX->Helloworld->getAll($value); 11 | } 12 | $this->addConfigs($settings); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "felixfbecker.php-intellisense", 4 | "felixfbecker.php-pack", 5 | "felixfbecker.php-debug", 6 | "neilbrayfield.php-docblocker", 7 | "esbenp.prettier-vscode", 8 | "eamodio.gitlens", 9 | "mgmcdermott.vscode-language-babel", 10 | "dbaeumer.vscode-eslint", 11 | "ms-vscode.vscode-typescript-tslint-plugin", 12 | "pflannery.vscode-versionlens", 13 | "ms-vsliveshare.vsliveshare-pack" 14 | ] 15 | } -------------------------------------------------------------------------------- /assets/README.md: -------------------------------------------------------------------------------- 1 | assets/css 2 | =========== 3 | 4 | This is for module specific styling 5 | 6 | assets/js 7 | ========== 8 | This is for module specific Java script. 9 | 10 | 11 | Javascript Libraries 12 | ==================== 13 | 14 | The following libraries are built in already and can be used without inclusion. 15 | 16 | 17 | - jquery-1.6.2.min.js 18 | - jquery-1.7.1.min.js 19 | - jquery-ui-1.8.16.min.js 20 | - jquery-ui-1.8.9.min.js 21 | - jquery.cookie.js 22 | - jquery.hotkeys.js 23 | - jquery.toggleval.3.0.js 24 | -------------------------------------------------------------------------------- /Restore.php: -------------------------------------------------------------------------------- 1 | getConfigs(); 7 | foreach ($settings as $key => $value) { 8 | $this->freepbx->Helloworld->setMultiConfig($value, $key); 9 | } 10 | } 11 | public function processLegacy($pdo, $data, $tables, $unknownTables, $tmpfiledir){ 12 | return $this->transformLegacyKV($pdo,'helloworld', $this->freepbx) 13 | ->transformNamespacedKV($pdo,'helloworld', $this->freepbx); 14 | } 15 | } -------------------------------------------------------------------------------- /views/default.php: -------------------------------------------------------------------------------- 1 |
2 |

3 |

4 |
5 |
6 |
7 |
8 |
9 | 10 |
11 |
12 |
13 | 18 |
19 |
20 |
21 | -------------------------------------------------------------------------------- /module.xml: -------------------------------------------------------------------------------- 1 | 2 | helloworld 3 | unsupported 4 | Hello World 5 | 15.0.1 6 | Development 7 | James Finstrom 8 | http://wiki.freepbx.org/pages/viewpage.action?pageId=19498386 9 | GPL 10 | http://www.gnu.org/licenses/gpl-2.0.txt 11 | 12 | 13 | 14 | 15 | 16 |
17 |
18 | 19 | Hello World 20 | 21 | 22 | 14 23 | 24 | 14.0 25 | 26 | This is the Hello World module used to learn by example for BMO used in 12+ 27 | 28 | *14.0.1* Code cleanup and some php 5.6 syntax 29 | *12.0.0.1* Initial Dev Release 30 | 31 |
32 | -------------------------------------------------------------------------------- /Console/Helloworld.class.php: -------------------------------------------------------------------------------- 1 | setName('helloworld') 17 | ->setDescription('This says hello to the world') 18 | ->setDefinition(array( 19 | new InputOption( 20 | 'flag', 21 | 'f', 22 | InputOption::VALUE_NONE, 23 | 'We are setting a flag' 24 | ), 25 | new InputArgument( 26 | 'args', 27 | InputArgument::IS_ARRAY, 28 | '[flag|f] arrrrrrgs', 29 | null 30 | ) 31 | )) 32 | ->setHelp('This is a magical help section...'); 33 | } 34 | protected function execute(InputInterface $input, OutputInterface $output) 35 | { 36 | $arg = $input->getArgument('args'); 37 | if ($input->getOption('flag')) { 38 | $text = "Flag Set."; 39 | } else { 40 | $text = "No Flag Set"; 41 | } 42 | $output->writeln($text); 43 | if ($arg) { 44 | print_r($arg); 45 | } 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | // ssh root@ 3 | // cd ~/.vscode-server/extensions/esbenp.prettier-vscode-1.9.0/ 4 | // npm install @prettier/plugin-php 5 | // I recommend to disable VS Code's built-in PHP IntelliSense by setting php.suggest.basic to false to avoid duplicate suggestions. 6 | "php.suggest.basic": false, 7 | "[php]": { 8 | "editor.defaultFormatter": "esbenp.prettier-vscode" 9 | }, 10 | // These are all my auto-save configs 11 | "editor.formatOnSave": true, 12 | // turn it off for JS and JSX, we will do this via eslint 13 | "[javascript]": { 14 | "editor.formatOnSave": false 15 | }, 16 | "[javascriptreact]": { 17 | "editor.formatOnSave": false 18 | }, 19 | // tell the ESLint plugin to run on save 20 | "eslint.autoFixOnSave": true, 21 | // Optional BUT IMPORTANT: If you have the prettier extension enabled for other languages like CSS and HTML, turn it off for JS since we are doing it through Eslint already 22 | "prettier.disableLanguages": [ 23 | "javascript", 24 | "typescript", 25 | "javascriptreact", 26 | "typescriptreact" 27 | ], 28 | "emmet.triggerExpansionOnTab": true, 29 | "files.associations": { 30 | "*.jsx": "javascriptreact" 31 | }, 32 | "intelephense.diagnostics.undefinedTypes": false, 33 | "intelephense.diagnostics.undefinedFunctions": false, 34 | "intelephense.diagnostics.undefinedConstants": false, 35 | "intelephense.diagnostics.undefinedClassConstants": false, 36 | "intelephense.diagnostics.undefinedMethods": false, 37 | "intelephense.diagnostics.undefinedProperties": false, 38 | "editor.codeActionsOnSave": { 39 | "source.fixAll.eslint": "explicit" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /views/form.php: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 |
5 |
6 |
7 |
8 |
9 |
10 | 11 | 12 |
13 |
14 | 15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 | 23 |
24 |
25 |
26 | 27 | 28 |
29 |
30 |
31 |
32 |
33 |
34 | 35 | 36 |
37 |
38 | 40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 | 48 |
49 |
50 |
51 | 52 |
-------------------------------------------------------------------------------- /.github/workflows/signrelease.yml: -------------------------------------------------------------------------------- 1 | name: Sign and Release Module 2 | 3 | on: 4 | push: 5 | branches: 6 | - 'release/*' 7 | - 'bugfix/*' 8 | - 'feature/*' 9 | 10 | jobs: 11 | sign_and_release_module: 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - name: Checkout code 16 | uses: actions/checkout@v4 17 | with: 18 | path : ${{ github.event.repository.name }} 19 | 20 | - name: Install GPG 21 | run: sudo apt-get update && sudo apt-get install gnupg xmlstarlet -y 22 | 23 | - name: Import GPG key 24 | run: echo "${{ secrets.GPG_SIGNING_KEY }}" | base64 --decode | gpg --import 25 | 26 | - name: Extract version and rawname from module.xml 27 | id: extract_info 28 | run: | 29 | version=$(awk -F'[><]' '//{print $3; exit}' ./${{ github.event.repository.name }}/module.xml) 30 | rawname=$(awk -F'[><]' '//{print $3; exit}' ./${{ github.event.repository.name }}/module.xml) 31 | echo "MODULE_VERSION=$version" >> $GITHUB_ENV 32 | echo "MODULE_RAWNAME=$rawname" >> $GITHUB_ENV 33 | 34 | # Assuming your module build/packaging places the file and signing script in the working directory 35 | - name: Sign module 36 | run: | 37 | chmod +x ./${{ github.event.repository.name }}/.github/workflows/sign.sh 38 | ./${{ github.event.repository.name }}/.github/workflows/sign.sh ${{env.MODULE_RAWNAME}} "${{ secrets.GPG_SIGNING_KEY }}" ./${{ github.event.repository.name }}/.github/workflows/exclude.txt 39 | 40 | - name: Push signed module to releases 41 | if: startsWith(github.ref, 'refs/heads/release/') || startsWith(github.ref, 'refs/heads/bugfix/') || startsWith(github.ref, 'refs/heads/feature/') 42 | uses: softprops/action-gh-release@4634c16e79c963813287e889244c50009e7f0981 43 | with: 44 | files: ${{env.MODULE_RAWNAME}}-${{env.MODULE_VERSION}}.tar.gz 45 | token: ${{ secrets.GITHUB_TOKEN }} 46 | tag_name: v${{env.MODULE_VERSION}} 47 | name: Release v${{env.MODULE_VERSION}} 48 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # helloworld 2 | 3 | FreePBX Hello World with BMO for 15+. Note: Some functionality may work on versions 12-14, though deprecated methods have been removed. 4 | 5 | ## Status 6 | 7 | This module is fully functional for managing notes. It installs successfully on FreePBX 13 and utilizes features exclusive to version 15, such as backup and restore. 8 | 9 | ## Scope 10 | 11 | This module aims to strike a balance between demonstrating key functionality and avoiding overwhelming complexity. The following tasks are covered: 12 | 13 | - [x] Basic Structure 14 | - [x] Writing to Database 15 | - [x] Reading from Database 16 | - [ ] Writing a Configuration File 17 | - [ ] Reading a Configuration File 18 | - [x] Displaying a Page 19 | - [x] Displaying a Populated Form 20 | - [x] Handling Form Submission 21 | - [x] Writing Dial Plan 22 | 23 | The UCP module may have its own scope and readme file, as it's not the primary focus of this example. 24 | 25 | ### TODO: 26 | 27 | - Hook into pages. 28 | - Implement creation/editing of a configuration file. 29 | - Comment and clarify code. 30 | 31 | ## Structure 32 | 33 | ### Folder Tree 34 | 35 | - rawname 36 | - assets 37 | - js 38 | - css 39 | - views 40 | - UCP (Optional) 41 | - assets 42 | - js 43 | - css 44 | - views 45 | - Api 46 | 47 | - Rest 48 | - Graphql 49 | 50 | #### rawname 51 | 52 | - `assets`: Contains CSS and JavaScript files. 53 | - `views`: HTML page views, devoid of logic. 54 | 55 | #### UCP 56 | 57 | Optional module for the user control panel, following the same directory structure as `rawname`. 58 | 59 | ## API - 15+ 60 | 61 | ### Files 62 | 63 | - `rawname/Rawname.class.php`: Primary module class. 64 | - `rawname/module.xml`: Module definition. 65 | - `rawname/rawname.page.php` 66 | 67 | ### Rawname.class.php 68 | 69 | Follow the convention of capitalizing the first letter. 70 | 71 | ### Required Methods (even if not used) 72 | 73 | These methods are mandatory, even if not utilized: 74 | 75 | - `public function install() {}` 76 | - `public function uninstall() {}` 77 | - `public function doConfigPageInit(\$page) {}` 78 | 79 | #### install method 80 | 81 | Replaces `install.php`. 82 | 83 | #### uninstall method 84 | 85 | Performs cleanup tasks. 86 | 87 | #### backup method (Future) 88 | 89 | Generates an array for potential restoration. 90 | 91 | #### restore method (Future) 92 | 93 | Accepts the array generated by the backup method for restoring previous configurations. 94 | 95 | #### doConfigPageInit method 96 | 97 | Essential for processing `$_REQUEST`. 98 | 99 | ### Functional Notes 100 | 101 | Avoid using `?>` followed by an empty newline, as PHP may encounter issues. Only use `?>` for inline PHP. 102 | 103 | ## Resources 104 | 105 | - Uniformity Guidelines: [FreePBX Wiki](http://wiki.freepbx.org/x/goDNAQ) 106 | - Code Snippets: [GitHub - FreePBX-gists](https://github.com/jfinstrom/FreePBX-gists) 107 | 108 | ## Support 109 | 110 | If you found this code helpful, consider supporting my employer, as it enables me to continue developing such projects. 111 | 112 | [ClearlyIP](https://clearlyip.com) 113 | 114 | ## License 115 | 116 | AGPLv3+ 117 | -------------------------------------------------------------------------------- /.github/workflows/sign.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # This creates and signs a .tar.gz file with a valid private key on your keyring. 4 | # 5 | # Params: sign.sh /location/of/module 6 | # 7 | # If key_base64 is supplied, it will be decoded and used as the GPG key. 8 | 9 | if [ ! "$1" ] || [ ! "$2" ] || [ ! "$3" ]; then 10 | echo "$0: /location/of/module " 11 | exit 1 12 | fi 13 | 14 | parse_xml_value() { 15 | local file="$1" 16 | local element="$2" 17 | xmlstarlet sel -t -v "/module/$element" "$file" 18 | } 19 | 20 | getHashes() { 21 | local dir="$1" 22 | local exclude_patterns="$2" 23 | 24 | if [ ! -d "$dir" ]; then 25 | echo "getHashes was given $dir which is not a directory!" 26 | exit 1 27 | fi 28 | 29 | # Use find + grep -v to filter based on exclude patterns 30 | while IFS= read -r -d '' file; do 31 | if [[ ! $file =~ $exclude_patterns ]]; then 32 | local hash 33 | hash=$(sha256sum "$file" | awk '{print $1}') 34 | printf "%s = %s\n" "${file#$dir/}" "$hash" 35 | fi 36 | done < <(find "$dir" -type f -print0) 37 | } 38 | 39 | loc="$1" 40 | key_base64="$2" 41 | keyindex=2 42 | exclude_file="$3" 43 | version=$(parse_xml_value "$loc/module.xml" "version") 44 | rawname=$(parse_xml_value "$loc/module.xml" "rawname") 45 | tarball_name="$rawname-$version.tar.gz" 46 | 47 | # Validate if version and rawname are extracted 48 | if [ -z "$version" ] || [ -z "$rawname" ]; then 49 | echo "Error: Could not extract version or rawname from module.xml" 50 | exit 1 51 | fi 52 | 53 | # Load exclude patterns if provided 54 | exclude_patterns="" 55 | if [ -f "$exclude_file" ]; then 56 | exclude_patterns=$(cat "$exclude_file" | xargs -0 | awk '{print "|" $0}') 57 | fi 58 | 59 | if [ "${loc: -1}" == "/" ]; then 60 | # Strip off any trailing slash 61 | loc="${loc:0:-1}" 62 | fi 63 | 64 | if [ ! -d "$loc" ]; then 65 | echo "$loc is not a directory" 66 | exit 1 67 | fi 68 | 69 | if [ ! -e "$loc/module.xml" ]; then 70 | echo "module.xml does not exist in $loc" 71 | exit 1 72 | fi 73 | 74 | # Decode the base64 encoded key 75 | key=$(echo "$key_base64" | base64 -d) 76 | 77 | # Import the decoded key into GPG 78 | echo "Importing GPG key..." 79 | echo "$key" | gpg --import - 80 | 81 | sig="$loc/module.sig" 82 | 83 | echo "Signing with provided key" 84 | echo -ne "\tGenerating file list..." 85 | rm -f "$sig" 86 | files=$(getHashes "$loc" "$exclude_patterns") 87 | echo "" 88 | echo -ne "\tSigning $sig.." 89 | { 90 | echo ";################################################" 91 | echo "# FreePBX Module Signature File #" 92 | echo ";################################################" 93 | echo "# Do not alter the contents of this file! If #" 94 | echo "# this file is tampered with, the module will #" 95 | echo "# fail validation and be marked as invalid! #" 96 | echo ";################################################" 97 | echo "" 98 | echo "[config]" 99 | echo "version=2" 100 | echo "hash=sha256" 101 | echo "signedwith=$key" 102 | echo "signedby=sign.php" 103 | echo "repo=manual" 104 | echo "type=public" 105 | echo "[hashes]" 106 | echo "$files" 107 | echo ";# End" 108 | } > >(gpg --default-key "268C8DD0" --clearsign >"$sig") 109 | echo "" 110 | echo -ne "\tCreating tarball $tarball_name..." 111 | tar -czf "$tarball_name" -X "$exclude_file" "$loc" 112 | echo "" 113 | echo "Done" 114 | -------------------------------------------------------------------------------- /Helloworld.class.php: -------------------------------------------------------------------------------- 1 | FreePBX = $freepbx; 18 | $this->Database = $freepbx->Database; 19 | } 20 | /** 21 | * Installer run on fwconsole ma install 22 | * 23 | * @return void 24 | */ 25 | public function install() 26 | { 27 | } 28 | 29 | /** 30 | * Uninstaller run on fwconsole ma uninstall 31 | * 32 | * @return void 33 | */ 34 | public function uninstall() 35 | { 36 | } 37 | 38 | /** 39 | * backup and restore methods not needed after framwork 40 | * 13.0.195.21 41 | * 14.0.5.1 42 | * 15.0.1.38 43 | * */ 44 | 45 | /** 46 | * Processes form submission and pre-page actions. 47 | * 48 | * @param string $page Display name 49 | * @return void 50 | */ 51 | public function doConfigPageInit($page) 52 | { 53 | /** getReq provided by FreePBX_Helpers see https://wiki.freepbx.org/x/0YGUAQ */ 54 | $action = $this->getReq('action', ''); 55 | $id = $this->getReq('id', ''); 56 | $subject = $this->getReq('subject', ''); 57 | $body = $this->getReq('body'); 58 | 59 | if ('add' == $action) { 60 | return $this->addItem($subject, $body); 61 | } 62 | 63 | if ('delete' == $action) { 64 | return $this->deleteItem($id); 65 | } 66 | 67 | if ('edit' == $action) { 68 | $this->updateItem($id, $subject, $body); 69 | } 70 | } 71 | 72 | /** 73 | * Adds buttons to the bottom of pages per set conditions 74 | * 75 | * @param array $request $_REQUEST 76 | * @return void 77 | */ 78 | public function getActionBar($request) 79 | { 80 | if ('helloworld' == $request['display']) { 81 | if (!isset($_GET['view'])) { 82 | return []; 83 | } 84 | $buttons = [ 85 | 'delete' => [ 86 | 'name' => 'delete', 87 | 'id' => 'delete', 88 | 'value' => _('Delete') 89 | ], 90 | 'reset' => [ 91 | 'name' => 'reset', 92 | 'id' => 'reset', 93 | 'value' => _("Reset") 94 | ], 95 | 'submit' => [ 96 | 'name' => 'submit', 97 | 'id' => 'submit', 98 | 'value' => _("Submit") 99 | ] 100 | ]; 101 | if (!isset($_GET['id']) || empty($_GET['id'])) { 102 | unset($buttons['delete']); 103 | } 104 | return $buttons; 105 | } 106 | } 107 | 108 | /** 109 | * Returns bool permissions for AJAX commands 110 | * https://wiki.freepbx.org/x/XoIzAQ 111 | * @param string $command The ajax command 112 | * @param array $setting ajax settings for this command typically untouched 113 | * @return bool 114 | */ 115 | public function ajaxRequest($command, &$setting) 116 | { 117 | //The ajax request 118 | if ("getJSON" == $command) { 119 | return true; 120 | } 121 | return false; 122 | } 123 | 124 | /** 125 | * Handle Ajax request 126 | * @url ajax.php?module=helloworld&command=getJSON&jdata=grid 127 | * 128 | * @return array 129 | */ 130 | public function ajaxHandler() 131 | { 132 | if ('getJSON' == $_REQUEST['command'] && 'grid' == $_REQUEST['jdata']) { 133 | return $this->getList(); 134 | } 135 | return json_encode([ 136 | 'status' => false, 137 | 'message' => _("Invalid Request") 138 | ]); 139 | } 140 | 141 | //Module getters These are all custom methods 142 | /** 143 | * getOne Gets an individual item by ID 144 | * @param int $id Item ID 145 | * @return array Returns an associative array with id, subject and body. 146 | */ 147 | public function getOne($id) 148 | { 149 | $sql = "SELECT id,subject,body FROM helloworld WHERE id = :id"; 150 | $stmt = $this->Database->prepare($sql); 151 | $stmt->bindParam(':id', $id, PDO::PARAM_INT); 152 | $stmt->execute(); 153 | $row = $stmt->fetchObject(); 154 | return [ 155 | 'id' => $row->id, 156 | 'subject' => $row->subject, 157 | 'body' => $row->body 158 | ]; 159 | } 160 | /** 161 | * getList gets a list od subjects and their respective id. 162 | * @return array id => subject 163 | */ 164 | public function getList() 165 | { 166 | $ret = []; 167 | $sql = 'SELECT id, subject FROM helloworld'; 168 | $data = $this->Database->query($sql)->fetchAll(PDO::FETCH_KEY_PAIR); 169 | array_walk($data, function (&$value, $key) { 170 | $value = ['id' => $key, 'subject' => $value]; 171 | }); 172 | return $data; 173 | } 174 | //Module setters these are all custom methods. 175 | 176 | /** 177 | * addItem Add an Item 178 | * @param string $subject The Subject of the item 179 | * @param [type] $body The body of the item 180 | */ 181 | public function addItem($subject, $body) 182 | { 183 | $sql = 184 | 'INSERT INTO helloworld (subject, body) VALUES (:subject, :body)'; 185 | $stmt = $this->Database->prepare($sql); 186 | $stmt->bindParam(':subject', $subject, \PDO::PARAM_STR); 187 | $stmt->bindParam(':body', $body, \PDO::PARAM_STR); 188 | $stmt->execute(); 189 | return $this; 190 | } 191 | /** 192 | * updateItem Updates the given ID 193 | * @param int $id Item ID 194 | * @param string $subject The new subject 195 | * @param string $body The new body 196 | * @return bool Returns true on success or false on failure 197 | */ 198 | public function updateItem($id, $subject, $body) 199 | { 200 | $sql = 201 | 'UPDATE helloworld SET subject = :subject, body = :body WHERE id = :id'; 202 | $stmt = $this->Database->prepare($sql); 203 | $stmt->bindParam(':subject', $subject, \PDO::PARAM_STR); 204 | $stmt->bindParam(':body', $body, \PDO::PARAM_STR); 205 | $stmt->bindParam(':id', $id, \PDO::PARAM_INT); 206 | $stmt->execute(); 207 | return $this; 208 | } 209 | /** 210 | * deleteItem Deletes the given ID 211 | * @param int $id Item ID 212 | * @return bool Returns true on success or false on failure 213 | */ 214 | public function deleteItem($id) 215 | { 216 | $sql = 'DELETE FROM helloworld WHERE id = :id'; 217 | $stmt = $this->Database->prepare($sql); 218 | $stmt->bindParam(':id', $id, \PDO::PARAM_INT); 219 | $stmt->execute(); 220 | return $this; 221 | } 222 | 223 | /** 224 | * Do we want to add to the dialplan? 225 | * https://wiki.freepbx.org/display/FOP/BMO+Hooks#BMOHooks-DialplanHooks 226 | * 227 | * @return bool or int 500 priority 228 | */ 229 | public function myDialplanHooks() 230 | { 231 | return true; 232 | } 233 | 234 | /** 235 | * Dialplan generation 236 | * 237 | * @param object $ext The dialplan object we add to 238 | * @param string $engine This will always be asterisk 239 | * @param int $priority 500? 240 | * @return void 241 | */ 242 | public function doDialplanHook(&$ext, $engine, $priority) 243 | { 244 | $modulename = 'helloworld'; 245 | 246 | // Retrieve module's feature code 247 | $fcc = new \featurecode($modulename, 'helloworld'); 248 | $hw_fc = $fcc->getCodeActive(); 249 | unset($fcc); 250 | 251 | $id = 'app-helloworld'; 252 | $ext->addInclude('from-internal-additional', $id); // Add the include to from-internal 253 | $ext->add( 254 | $id, 255 | $hw_fc, 256 | '', 257 | new \ext_goto('1', 's', 'app-helloworld-playback') 258 | ); // feature code goes to playback context 259 | 260 | $id = 'app-helloworld-playback'; 261 | $c = 's'; 262 | $ext->add($id, $c, 'label', new \ext_answer()); 263 | $ext->add($id, $c, '', new \ext_wait(1)); 264 | $ext->add($id, $c, '', new \ext_playback('hello-world')); 265 | $ext->add($id, $c, '', new \ext_playback('demo-congrats')); 266 | $ext->add($id, $c, 'hangup', new \ext_hangup()); 267 | } 268 | 269 | /** 270 | * This returns html to the main page 271 | * 272 | * @return string html 273 | */ 274 | public function showPage() 275 | { 276 | $subhead = _('Item List'); 277 | $content = load_view(__DIR__ . '/views/grid.php'); 278 | 279 | if ('form' == $_REQUEST['view']) { 280 | $subhead = _('Add Item'); 281 | $content = load_view(__DIR__ . '/views/form.php'); 282 | if (isset($_REQUEST['id']) && !empty($_REQUEST['id'])) { 283 | $subhead = _('Edit Item'); 284 | $content = load_view( 285 | __DIR__ . '/views/form.php', 286 | $this->getOne($_REQUEST['id']) 287 | ); 288 | } 289 | } 290 | echo load_view(__DIR__ . '/views/default.php', array( 291 | 'subhead' => $subhead, 292 | 'content' => $content 293 | )); 294 | } 295 | } 296 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 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 by 637 | 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 | --------------------------------------------------------------------------------