├── .gitignore ├── .eslintignore ├── .eslintrc.json ├── src ├── index.js └── MwApiPlugin.js ├── CONTRIBUTING.md ├── .github └── workflows │ └── publish.yml ├── package.json ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | .idea/ 3 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | package-lock.json 3 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "wikimedia/server", 3 | "env": { 4 | "commonjs": true, 5 | "es6": true, 6 | "node": true 7 | }, 8 | "parserOptions": { 9 | "ecmaVersion": 2017 10 | }, 11 | "rules": { 12 | "max-len": [ "error", 120 ] 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const MwApiPlugin = require( './MwApiPlugin' ); 4 | 5 | const mwApiCommands = MwApiPlugin.mwApiCommands; 6 | 7 | const Util = { 8 | getTestString: ( prefix = '' ) => prefix + Math.random().toString() + '-Iñtërnâtiônàlizætiøn' 9 | }; 10 | 11 | module.exports = { 12 | Util, 13 | mwApiCommands 14 | }; 15 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | ## How to make a new Release 4 | 5 | 1. Update version number in package.json (follow [Semantic Versioning](https://semver.org/)) in an extra commit 6 | 1. Merge the Pull Request with that commit 7 | 1. Tag the commit with the new version number on master locally and push the tag to GitHub 8 | 1. On GitHub create a new "[Release](https://github.com/wmde/cypress-wikibase-api/releases)" for the tag with information on what changed 9 | 1. GitHub actions will push the new Release to [npm](https://www.npmjs.com/package/cypress-wikibase-api) 10 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Verify and Publish 2 | 3 | on: 4 | release: 5 | types: [ released ] 6 | 7 | jobs: 8 | publish: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v4 12 | - uses: actions/setup-node@v4 13 | with: 14 | node-version: 18 15 | registry-url: https://registry.npmjs.org/ 16 | - name: Install 17 | run: npm ci 18 | - name: Test 19 | run: npm test 20 | - name: Publish 21 | run: | 22 | echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_AUTH_TOKEN }}" > ${NPM_CONFIG_USERCONFIG} 23 | npm publish --access public 24 | env: 25 | NODE_AUTH_TOKEN: ${{secrets.npm_token}} 26 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "src/index.js", 3 | "files": [ 4 | "src" 5 | ], 6 | "dependencies": { 7 | "api-testing": "^1.7.0" 8 | }, 9 | "name": "cypress-wikibase-api", 10 | "version": "0.0.7", 11 | "description": "Support package for developing cypress tests that use the Wikibase API", 12 | "homepage": "https://github.com/wmde/cypress-wikibase-api", 13 | "bugs": "https://phabricator.wikimedia.org", 14 | "license": "GPL-2.0-or-later", 15 | "repository": { 16 | "type": "git", 17 | "url": "https://github.com/wmde/cypress-wikibase-api" 18 | }, 19 | "keywords": [ 20 | "mediawiki", 21 | "wikibase", 22 | "cypress-plugin" 23 | ], 24 | "engines": { 25 | "node": ">=18.0" 26 | }, 27 | "scripts": { 28 | "test": "eslint ." 29 | }, 30 | "devDependencies": { 31 | "eslint": "^8.57.0", 32 | "eslint-config-wikimedia": "^0.28.2" 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cypress-wikibase-api 2 | Cypress plugin and utility functions for writing Cypress tests of Wikibase 3 | 4 | This module contains Cypress tasks to be used in Cypress browser tests for Wikibase and its extensions. 5 | 6 | ## Usage example 7 | 8 | For example, in the Cypress tests in WikibaseLexeme, we use the API to get data about an entity that we created during our testing: 9 | 10 | ```javascript 11 | lexemePage.headerId().then( ( lexemeId ) => { 12 | cy.task( 'MwApi:GetEntityData', { entityId: lexemeId } ).then( ( lexeme ) => { 13 | expect( lexeme.lemmas[ languageItemsLanguageCode ].value ).to.eq( lemma ); 14 | expect( lexeme.language ).to.eq( languageId ); 15 | expect( lexeme.lexicalCategory ).to.eq( lexicalCategoryId ); 16 | } ); 17 | }); 18 | ``` 19 | 20 | ## Development 21 | 22 | When testing changes locally, you can install the checked-out module from the project that you are working on: 23 | 24 | ``` 25 | npm rm cypress-wikibase-api 26 | npm i -D ~/work/cypress-wikibase-api 27 | ``` 28 | 29 | ## Contributing 30 | 31 | Please file any bugs or issues with our issue-tracker at [phabricator.wikimedia.org](https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?tags=Wikidata,Browser-Tests). 32 | 33 | For instruction of how to create a new release, please see [CONTRIBUTING.md](CONTRIBUTING.md) 34 | -------------------------------------------------------------------------------- /src/MwApiPlugin.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Helper methods for generic MediaWiki API functionality separate from the Cypress browser context 3 | */ 4 | 'use strict'; 5 | 6 | // needed for api-testing library, see api-testing/lib/config.js 7 | process.env.REST_BASE_URL = process.env.MW_SERVER + process.env.MW_SCRIPT_PATH + '/'; 8 | 9 | const ApiTesting = require( 'api-testing' ); 10 | const { clientFactory, utils } = ApiTesting; 11 | 12 | const state = { 13 | users: { 14 | root: null, 15 | bot: null 16 | }, 17 | tokens: { 18 | botToken: null 19 | } 20 | }; 21 | 22 | module.exports = { 23 | mwApiCommands( cypressConfig ) { 24 | async function root( withCache = true ) { 25 | if ( state.users.root && withCache ) { 26 | return state.users.root; 27 | } 28 | const rootClient = clientFactory.getActionClient( null ); 29 | await rootClient.login( 30 | cypressConfig.mediawikiAdminUsername, 31 | cypressConfig.mediawikiAdminPassword 32 | ); 33 | await rootClient.loadTokens( [ 'createaccount', 'userrights', 'csrf' ] ); 34 | 35 | const rightsToken = await rootClient.token( 'userrights' ); 36 | if ( rightsToken === '+\\' ) { 37 | throw new Error( 'Failed to get the root user tokens.' ); 38 | } 39 | 40 | if ( withCache ) { 41 | state.users.root = rootClient; 42 | } 43 | return rootClient; 44 | } 45 | 46 | async function botUser() { 47 | if ( state.users.bot ) { 48 | return state.users.bot; 49 | } 50 | const name = utils.title( 'r2d2' ); 51 | const password = utils.title( 'very-secret-' ); 52 | 53 | const rootUser = await root( false ); 54 | await rootUser.createAccount( { username: name, password } ); 55 | await rootUser.addGroups( name, [ 'bot' ] ); 56 | 57 | await rootUser.login( name, password ); 58 | 59 | state.users.bot = rootUser; 60 | 61 | return rootUser; 62 | } 63 | 64 | async function getBotEditToken( bot ) { 65 | if ( state.tokens.botToken ) { 66 | return state.tokens.botToken; 67 | } 68 | const token = await bot.request( { 69 | action: 'query', 70 | meta: 'tokens', 71 | type: 'csrf' 72 | } ).then( ( response ) => { 73 | if ( response.body.query && response.body.query.tokens && response.body.query.tokens.csrftoken ) { 74 | return response.body.query.tokens.csrftoken; 75 | } else { 76 | const err = new Error( 'Could not get edit token' ); 77 | err.response = response; 78 | throw err; 79 | } 80 | } ); 81 | 82 | state.tokens.botToken = token; 83 | 84 | return token; 85 | } 86 | 87 | async function createEntity( entityType, label, data ) { 88 | const itemData = {}; 89 | let labels = {}; 90 | 91 | if ( typeof label === 'object' ) { 92 | labels = label; 93 | } else if ( label ) { 94 | labels = { 95 | en: { 96 | language: 'en', 97 | value: label 98 | } 99 | }; 100 | } 101 | 102 | Object.assign( itemData, { labels }, data ); 103 | 104 | const bot = await botUser(); 105 | const botToken = await getBotEditToken( bot ); 106 | 107 | const response = await bot.request( { 108 | action: 'wbeditentity', 109 | new: entityType, 110 | data: JSON.stringify( itemData ), 111 | token: botToken 112 | }, true ); 113 | return response.body.entity.id; 114 | } 115 | 116 | async function createProperty( datatype, label, data ) { 117 | const propertyData = {}; 118 | let labels = {}; 119 | 120 | if ( typeof label === 'object' ) { 121 | labels = label; 122 | } else if ( label ) { 123 | labels = { 124 | en: { 125 | language: 'en', 126 | value: label 127 | } 128 | }; 129 | } 130 | 131 | Object.assign( propertyData, { datatype, labels }, data ); 132 | 133 | const rootClient = await root(); 134 | const response = await rootClient.action( 'wbeditentity', { 135 | new: 'property', 136 | data: JSON.stringify( propertyData ), 137 | token: await rootClient.token() 138 | }, 'POST' ); 139 | return response.entity.id; 140 | } 141 | 142 | async function addSense( lexemeId, data ) { 143 | const rootClient = await root(); 144 | const response = await rootClient.action( 'wbladdsense', { 145 | lexemeId, 146 | data: JSON.stringify( data ), 147 | token: await rootClient.token() 148 | }, 'POST' ); 149 | return response.sense.id; 150 | } 151 | 152 | async function addForm( lexemeId, data ) { 153 | const rootClient = await root(); 154 | const response = await rootClient.action( 'wbladdform', { 155 | lexemeId, 156 | data: JSON.stringify( data ), 157 | token: await rootClient.token() 158 | }, 'POST' ); 159 | return response.form.id; 160 | } 161 | 162 | return { 163 | async 'MwApi:BlockUser'( { username, reason, expiry } ) { 164 | const rootClient = await root(); 165 | const blockResult = await rootClient.action( 'block', { 166 | user: username, 167 | assert: 'user', 168 | reason: reason || 'Set up blocked user', 169 | expiry: expiry || 'never', 170 | token: await rootClient.token() 171 | }, 'POST' ); 172 | 173 | if ( !blockResult.block ) { 174 | return Promise.reject( new Error( 'Failed to block user.' ) ); 175 | } 176 | 177 | return Promise.resolve( null ); 178 | }, 179 | async 'MwApi:CreateUser'( { usernamePrefix } ) { 180 | const rootUser = await root(); 181 | const username = utils.title( usernamePrefix + '-' ); 182 | const password = utils.uniq(); 183 | await rootUser.createAccount( { username: username, password: password } ); 184 | 185 | return Promise.resolve( { username, password } ); 186 | }, 187 | async 'MwApi:CreateItem'( { label, data } ) { 188 | return createEntity( 'item', label, data ); 189 | }, 190 | async 'MwApi:CreateEntity'( { entityType, label, data } ) { 191 | return createEntity( entityType, label, data ); 192 | }, 193 | async 'MwApi:CreateProperty'( { datatype, label, data } ) { 194 | return createProperty( datatype, label, data ); 195 | }, 196 | async 'MwApi:AddSense'( { lexemeId, data } ) { 197 | return addSense( lexemeId, data ); 198 | }, 199 | async 'MwApi:AddForm'( { lexemeId, data } ) { 200 | return addForm( lexemeId, data ); 201 | }, 202 | async 'MwApi:GetOrCreatePropertyIdByDataType'( { datatype } ) { 203 | if ( !( 'wikibasePropertyIds' in cypressConfig ) ) { 204 | cypressConfig.wikibasePropertyIds = {}; 205 | } 206 | if ( cypressConfig.wikibasePropertyIds[ datatype ] ) { 207 | return Promise.resolve( cypressConfig.wikibasePropertyIds[ datatype ] ); 208 | } else { 209 | return createProperty( datatype, utils.title( datatype ) ) 210 | .then( ( propertyId ) => { 211 | cypressConfig.wikibasePropertyIds[ datatype ] = propertyId; 212 | return propertyId; 213 | } ); 214 | } 215 | }, 216 | async 'MwApi:GetEntityData'( { entityId } ) { 217 | const bot = await botUser(); 218 | 219 | return bot.request( { 220 | action: 'wbgetentities', 221 | ids: entityId 222 | } ).then( ( response ) => response.body.entities[ entityId ] ); 223 | }, 224 | async 'MwApi:UnblockUser'( { username, reason } ) { 225 | const rootClient = await root(); 226 | const unblockResult = await rootClient.action( 'unblock', { 227 | user: username, 228 | assert: 'user', 229 | reason: reason || 'Unblocked user', 230 | token: await rootClient.token() 231 | }, 'POST' ); 232 | 233 | if ( !unblockResult.unblock ) { 234 | return Promise.reject( new Error( 'Failed to unblock user.' ) ); 235 | } 236 | 237 | return Promise.resolve( null ); 238 | }, 239 | async 'MwApi:BotRequest'( { isEdit, isPost, parameters } ) { 240 | const bot = await botUser(); 241 | const requestParams = Object.assign( {}, parameters ); 242 | if ( isEdit ) { 243 | const botToken = await getBotEditToken( bot ); 244 | requestParams.token = botToken; 245 | } 246 | return bot.request( requestParams, isPost ).then( ( response ) => response.body ); 247 | } 248 | }; 249 | } 250 | }; 251 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------