├── lib ├── lombok.jar └── apache-commons-codec-1.4.jar ├── .settings ├── org.eclipse.ltk.core.refactoring.prefs ├── org.eclipse.jst.j2ee.ejb.annotations.xdoclet.prefs ├── org.eclipse.wst.common.project.facet.core.xml └── org.eclipse.jdt.core.prefs ├── .gitignore ├── .classpath ├── .project ├── README.md ├── src └── BigBlueButton │ ├── api │ ├── BBBMeeting.java │ └── BBBException.java │ └── impl │ ├── BBBModule.java │ ├── BBBAPI.java │ └── BaseBBBAPI.java └── LICENSE /lib/lombok.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigbluebutton/bigbluebutton-api-java/HEAD/lib/lombok.jar -------------------------------------------------------------------------------- /lib/apache-commons-codec-1.4.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bigbluebutton/bigbluebutton-api-java/HEAD/lib/apache-commons-codec-1.4.jar -------------------------------------------------------------------------------- /.settings/org.eclipse.ltk.core.refactoring.prefs: -------------------------------------------------------------------------------- 1 | eclipse.preferences.version=1 2 | org.eclipse.ltk.core.refactoring.enable.project.refactoring.history=false 3 | -------------------------------------------------------------------------------- /.settings/org.eclipse.jst.j2ee.ejb.annotations.xdoclet.prefs: -------------------------------------------------------------------------------- 1 | XDOCLETBUILDERACTIVE=true 2 | XDOCLETHOME= 3 | XDOCLETUSEGLOBAL=true 4 | XDOCLETVERSION=1.2.1 5 | eclipse.preferences.version=1 6 | -------------------------------------------------------------------------------- /.settings/org.eclipse.wst.common.project.facet.core.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled class file 2 | *.class 3 | 4 | # Log file 5 | *.log 6 | 7 | # BlueJ files 8 | *.ctxt 9 | 10 | # Mobile Tools for Java (J2ME) 11 | .mtj.tmp/ 12 | 13 | # Package Files # 14 | #*.jar # in order to include external library 15 | *.war 16 | *.ear 17 | *.zip 18 | *.tar.gz 19 | *.rar 20 | 21 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 22 | hs_err_pid* 23 | /build/ 24 | -------------------------------------------------------------------------------- /.classpath: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /.project: -------------------------------------------------------------------------------- 1 | 2 | 3 | bigbluebutton-api-java 4 | 5 | 6 | 7 | 8 | 9 | org.eclipse.jdt.core.javabuilder 10 | 11 | 12 | 13 | 14 | org.eclipse.wst.common.project.facet.core.builder 15 | 16 | 17 | 18 | 19 | 20 | org.eclipse.wst.common.project.facet.core.nature 21 | org.eclipse.jdt.core.javanature 22 | 23 | 24 | -------------------------------------------------------------------------------- /.settings/org.eclipse.jdt.core.prefs: -------------------------------------------------------------------------------- 1 | eclipse.preferences.version=1 2 | org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled 3 | org.eclipse.jdt.core.compiler.codegen.methodParameters=do not generate 4 | org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8 5 | org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve 6 | org.eclipse.jdt.core.compiler.compliance=1.8 7 | org.eclipse.jdt.core.compiler.debug.lineNumber=generate 8 | org.eclipse.jdt.core.compiler.debug.localVariable=generate 9 | org.eclipse.jdt.core.compiler.debug.sourceFile=generate 10 | org.eclipse.jdt.core.compiler.problem.assertIdentifier=error 11 | org.eclipse.jdt.core.compiler.problem.enumIdentifier=error 12 | org.eclipse.jdt.core.compiler.source=1.8 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | Special note: 3 | 1. This project used Lombok library, if you want to deploy this project, make sure you have Lombok installed. To install, follow the following steps: 4 | - download from https://projectlombok.org/download 5 | - go to the location where the Lombar.jar was downloaded, and run "java -jar lombok.jar", change the jar file name to the name of the lombok jar file that you downloaded 6 | - after you run the previous step, a window should appear, brownse to your editor location (for eclipse, it's where eclipse.exe is located) 7 | - click install 8 | - launch Eclipse (or other IDE) 9 | - add the zomlok library to your project (right click on the properties -> Java Build Path -> Libraries -> add Extenal JARs -> select the lombok jar file that you just downloaded -> Apply and Close 10 | 11 | -------------------------------------------------------------------------------- /src/BigBlueButton/api/BBBMeeting.java: -------------------------------------------------------------------------------- 1 | package BigBlueButton.api; 2 | 3 | import java.util.Map; 4 | import java.util.Date; 5 | import java.util.HashMap; 6 | 7 | import lombok.AccessLevel; 8 | import lombok.Getter; 9 | import lombok.Setter; 10 | import lombok.ToString; 11 | 12 | /** 13 | * Object for a BigBlueButton meeting. 14 | * @author Adrian Fish 15 | * Based on: https://github.com/sakaicontrib/bbb-tool/blob/master/api/src/java/org/sakaiproject/bbb/api/BBBMeeting.java 16 | * 17 | * Last modified by Yunkai Wang 18 | */ 19 | @Getter @Setter @ToString 20 | public class BBBMeeting { 21 | private String name = null; 22 | private String meetingID; 23 | private String attendeePW = null; 24 | private String moderatorPW = null; 25 | private String dialNumber = null; 26 | private String voiceBridge = null; 27 | private String webVoice = null; 28 | private String logoutURL = null; 29 | private Boolean record = null; 30 | private Long duration = null; 31 | 32 | // user cannot directly modify this field 33 | @Setter (AccessLevel.NONE) 34 | private Map meta = new HashMap(); 35 | private String moderatorOnlyMessage = null; 36 | private Boolean autoStartRecording = null; 37 | private Boolean allowStartStopRecording = null; 38 | private Boolean webcamsOnlyForModerator = null; 39 | private String logo = null; 40 | private String copyright = null; 41 | private Boolean muteOnStart = null; 42 | private String welcome = null; 43 | private Date startDate = null; 44 | private Date endDate = null; 45 | 46 | public BBBMeeting(String meetingID) { 47 | this.meetingID = meetingID; 48 | } 49 | 50 | public void addMeta(String key, String value) { 51 | meta.put(key, value); 52 | } 53 | 54 | public void removeMeta(String key) { 55 | if (meta.containsKey(key)) 56 | meta.remove(key); 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /src/BigBlueButton/api/BBBException.java: -------------------------------------------------------------------------------- 1 | package BigBlueButton.api; 2 | 3 | /** 4 | * Exception generated while communicating with BBB server 5 | * 6 | * see https://github.com/sakaicontrib/bbb-tool/blob/master/api/src/java/org/sakaiproject/bbb/api/BBBException.java 7 | */ 8 | public class BBBException extends Exception { 9 | private static final long serialVersionUID = 2421100107566638321L; 10 | 11 | public static final String MESSAGEKEY_HTTPERROR = "httpError"; 12 | public static final String MESSAGEKEY_NOTFOUND = "notFound"; 13 | public static final String MESSAGEKEY_NOACTION = "noActionSpecified"; 14 | public static final String MESSAGEKEY_IDNOTUNIQUE = "idNotUnique"; 15 | public static final String MESSAGEKEY_NOTSTARTED = "notStarted"; 16 | public static final String MESSAGEKEY_ALREADYENDED = "alreadyEnded"; 17 | public static final String MESSAGEKEY_INTERNALERROR = "internalError"; 18 | public static final String MESSAGEKEY_UNREACHABLE = "unreachableServerError"; 19 | public static final String MESSAGEKEY_INVALIDRESPONSE = "invalidResponseError"; 20 | public static final String MESSAGEKEY_GENERALERROR = "generalError"; 21 | 22 | private String messageKey; 23 | 24 | public BBBException(String messageKey, String message, Throwable cause) { 25 | super(message, cause); 26 | this.messageKey = messageKey; 27 | } 28 | 29 | public BBBException(String messageKey, String message) { 30 | super(message); 31 | this.messageKey = messageKey; 32 | } 33 | 34 | public String getMessageKey() { 35 | return messageKey; 36 | } 37 | 38 | public void setMessageKey(String messageKey) { 39 | this.messageKey = messageKey; 40 | } 41 | 42 | public String getPrettyMessage() { 43 | String _message = getMessage(); 44 | String _messageKey = getMessageKey(); 45 | 46 | StringBuilder pretty = new StringBuilder(); 47 | if(_message != null) { 48 | pretty.append(_message); 49 | } 50 | if(_messageKey != null && !"".equals(_messageKey.trim())) { 51 | pretty.append(" ("); 52 | pretty.append(_messageKey); 53 | pretty.append(")"); 54 | } 55 | return pretty.toString(); 56 | } 57 | 58 | } -------------------------------------------------------------------------------- /src/BigBlueButton/impl/BBBModule.java: -------------------------------------------------------------------------------- 1 | package BigBlueButton.impl; 2 | 3 | import java.io.BufferedReader; 4 | import java.io.File; 5 | import java.io.FileReader; 6 | import java.io.IOException; 7 | import java.util.HashMap; 8 | import java.util.LinkedList; 9 | import java.util.Map; 10 | import org.apache.commons.codec.binary.Base64; 11 | 12 | /** 13 | * Java class that stores that modules configuration to be used for create BigBlueButton meeting. 14 | * See the following url for more details 15 | * https://github.com/mconf/bigbluebutton-api-ruby/blob/master/lib/bigbluebutton_modules.rb 16 | * 17 | * @author Yunkai Wang 18 | */ 19 | public class BBBModule { 20 | public enum PresentationType { 21 | url, file, base64; 22 | } 23 | 24 | private LinkedList presentation_urls = new LinkedList(); 25 | private LinkedList presentation_files = new LinkedList(); 26 | private Map presentation_base64s = new HashMap(); 27 | 28 | public void add_presentation(PresentationType type, String value) { 29 | add_presentation(type, value, ""); 30 | } 31 | 32 | public void add_presentation(PresentationType type, String value, String name) { 33 | switch (type) { 34 | case url: 35 | presentation_urls.add(value); 36 | return; 37 | case file: 38 | presentation_files.add(value); 39 | return; 40 | case base64: 41 | presentation_base64s.put(name, value); 42 | return; 43 | } 44 | } 45 | 46 | public String to_xml() throws IOException { 47 | if (!has_presentation()) return ""; 48 | String xml = ""; 49 | xml += presentations_to_xml(); 50 | xml += ""; 51 | return xml; 52 | } 53 | 54 | private String presentations_to_xml() throws IOException { 55 | String xml = ""; 56 | for (String url : presentation_urls) 57 | xml += String.format("", url); 58 | for (Map.Entry entry : presentation_base64s.entrySet()) { 59 | xml += String.format("", entry.getKey()); 60 | xml += entry.getValue(); 61 | xml += ""; 62 | } 63 | 64 | for (String fileName : presentation_files) { 65 | File f = new File(fileName); 66 | xml += String.format("", f.getName()); 67 | FileReader fr = new FileReader(fileName); 68 | BufferedReader br = new BufferedReader(fr); 69 | String file = ""; 70 | String line = ""; 71 | while ((line = br.readLine()) != null) 72 | file += line + "\n"; 73 | br.close(); 74 | byte[] bytes = Base64.encodeBase64(file.getBytes()); 75 | for (byte b : bytes) 76 | xml += (char)b; 77 | xml += ""; 78 | } 79 | xml += ""; 80 | return xml; 81 | } 82 | 83 | private boolean has_presentation() { 84 | return !(presentation_urls.isEmpty() && 85 | presentation_files.isEmpty() && 86 | presentation_base64s.isEmpty()); 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /src/BigBlueButton/impl/BBBAPI.java: -------------------------------------------------------------------------------- 1 | package BigBlueButton.impl; 2 | 3 | import java.util.Map; 4 | import BigBlueButton.api.BBBException; 5 | import BigBlueButton.api.BBBMeeting; 6 | 7 | /** 8 | * List of supported API for BigBlueButton, see BigBlueButton doc for more information 9 | * Based on: https://github.com/sakaicontrib/bbb-tool/blob/master/impl/src/java/org/sakaiproject/bbb/impl/bbbapi/BBBAPI.java 10 | * 11 | * Last modified by Yunkai Wang 12 | */ 13 | public interface BBBAPI { 14 | 15 | /** 16 | * Get the API version of the server 17 | * 18 | * @return API version 19 | */ 20 | public String getAPIVersion(); 21 | 22 | /** 23 | * Get the base url of the server 24 | * 25 | * @return url 26 | */ 27 | public String getUrl(); 28 | 29 | /** 30 | * Allow user to create meeting 31 | * 32 | * @return BBBMeeting object on success, on failure, BBBException is thrown 33 | * @throws BBBException 34 | */ 35 | public BBBMeeting createMeeting(final String meetingID) throws BBBException; 36 | public BBBMeeting createMeeting(final BBBMeeting meeting) throws BBBException; 37 | public BBBMeeting createMeeting(final BBBMeeting meeting, final BBBModule module) throws BBBException; 38 | 39 | /** 40 | * Check if the meeting is already running 41 | * 42 | * @return true if the meeting is running, false otherwise 43 | * @throws BBBException 44 | */ 45 | public boolean isMeetingRunning(String meetingID) throws BBBException; 46 | 47 | /** 48 | * Get meeting information corresponds to the given meetingID and role 49 | * 50 | * @return Map that contains all meeting information 51 | * @throws BBBException 52 | */ 53 | public Map getMeetingInfo(String meetingID, String password) throws BBBException; 54 | public Map getMeetingInfo(final BBBMeeting meeting) throws BBBException; 55 | 56 | /** 57 | * End the given meeting 58 | * 59 | * @return true if the meeting is successfully ended or does not exist, false otherwise 60 | * @throws BBBException 61 | */ 62 | public boolean endMeeting(String meetingID, String password) throws BBBException; 63 | public boolean endMeeting(final BBBMeeting meeting) throws BBBException; 64 | 65 | /** 66 | * Get the url to join the given meeting with the display name and corresponding role type 67 | * 68 | * @return url for joining the meeting 69 | */ 70 | public String getJoinMeetingURL(String meetingID, String password, String userDisplayName); 71 | public String getJoinMeetingURL(String meetingID, String password, String userDisplayName, String userId); 72 | 73 | /** 74 | * Get the list of all live meetings in server, every parameter like meetingIDs can be a list of meetings but separated 75 | * by commas(e.g., "id1,id2") 76 | * 77 | * @return a map which has a field named meetings, and the value is the list of meeting information 78 | * @throws BBBException 79 | */ 80 | public Map getMeetings() throws BBBException; 81 | 82 | /** 83 | * Get the list of recordings that map the given fields 84 | * 85 | * @return a map which has a field named recordings, and the value is the list of recording information 86 | * @throws BBBException 87 | */ 88 | public Map getRecordings() throws BBBException; 89 | public Map getRecordings(String meetingIDs) throws BBBException; 90 | public Map getRecordings(String meetingIDs, String recordIDs) throws BBBException; 91 | public Map getRecordings(String meetingIDs, String recordIDs, String states) throws BBBException; 92 | public Map getRecordings(String meetingIDs, String recordIDs, String states, Map meta) throws BBBException; 93 | 94 | /** 95 | * Delete a given recording (or a list of recordings whose ids are separated by commas) 96 | * 97 | * @return true if the recording is successfully deleted, exception is thrown on failure 98 | * @throws BBBException 99 | */ 100 | public boolean deteteRecordings(String recordIDs) throws BBBException; 101 | 102 | /** 103 | * Publish/unpublish the recording(s) 104 | * 105 | * @return true if the recording(s) is successfully published/unpublished, exception is thrown on failure 106 | * @throws BBBException 107 | */ 108 | public boolean publishRecordings(String recordIDs, boolean publish) throws BBBException; 109 | 110 | /** 111 | * Update the recording(s) 112 | * 113 | * @return true if the recording(s) is successfully updated, exception is thrown on failure 114 | * @throws BBBException 115 | */ 116 | public boolean updateRecordings(String recordIDs) throws BBBException; 117 | public boolean updateRecordings(String recordIDs, Map meta) throws BBBException; 118 | 119 | /** 120 | * Get the default config xml file from the BBB server and save it to the given file path 121 | * 122 | * @return true on success, on failure, BBBException is thrown 123 | * @throws BBBException 124 | */ 125 | public boolean getDefaultConfigXML(String fileName) throws BBBException; 126 | 127 | 128 | /** 129 | * Set the config for the given meeting 130 | * 131 | * @return true on success, on failure, BBBException is thrown 132 | * @throws BBBException 133 | */ 134 | public boolean setConfigXML(String meetingID, String fileName) throws BBBException; 135 | } 136 | -------------------------------------------------------------------------------- /src/BigBlueButton/impl/BaseBBBAPI.java: -------------------------------------------------------------------------------- 1 | package BigBlueButton.impl; 2 | 3 | import java.io.BufferedReader; 4 | import java.io.DataOutputStream; 5 | import java.io.File; 6 | import java.io.FileInputStream; 7 | import java.io.FileOutputStream; 8 | import java.io.IOException; 9 | import java.io.InputStreamReader; 10 | import java.io.StringReader; 11 | import java.io.UnsupportedEncodingException; 12 | import java.net.HttpURLConnection; 13 | import java.net.URL; 14 | import java.net.URLEncoder; 15 | import java.text.ParseException; 16 | import java.text.SimpleDateFormat; 17 | import java.util.ArrayList; 18 | import java.util.List; 19 | import java.util.Map; 20 | import java.util.Map.Entry; 21 | import java.util.HashMap; 22 | 23 | import javax.xml.parsers.DocumentBuilder; 24 | import javax.xml.parsers.DocumentBuilderFactory; 25 | import javax.xml.parsers.ParserConfigurationException; 26 | 27 | import BigBlueButton.api.BBBException; 28 | import BigBlueButton.api.BBBMeeting; 29 | 30 | import org.apache.commons.codec.digest.DigestUtils; 31 | import org.w3c.dom.Document; 32 | import org.w3c.dom.Node; 33 | import org.w3c.dom.NodeList; 34 | import org.xml.sax.InputSource; 35 | import org.xml.sax.SAXException; 36 | 37 | /** 38 | * Base class for interacting with any BigBlueButton API version. 39 | * @author Nuno Fernandes 40 | * 41 | * Last modified by Yunkai Wang 42 | */ 43 | public class BaseBBBAPI implements BBBAPI { 44 | /** 45 | * BBB server url, including bigbluebutton webapp path. Will default to 46 | * http://localhost/bigbluebutton if not specified 47 | */ 48 | protected String bbbUrl = "http://127.0.0.1/bigbluebutton"; 49 | /** BBB security salt */ 50 | protected String bbbSalt = null; 51 | 52 | // API Server Path 53 | protected final static String API_SERVERPATH = "/api/"; 54 | 55 | // API Calls 56 | protected final static String APICALL_CREATE = "create"; 57 | protected final static String APICALL_ISMEETINGRUNNING = "isMeetingRunning"; 58 | protected final static String APICALL_GETMEETINGINFO = "getMeetingInfo"; 59 | protected final static String APICALL_GETMEETINGS = "getMeetings"; 60 | protected final static String APICALL_JOIN = "join"; 61 | protected final static String APICALL_END = "end"; 62 | protected final static String APICALL_VERSION = ""; 63 | protected final static String APICALL_getRecordS = "getRecordings"; 64 | protected final static String APICALL_PUBLISHRECORDINGS = "publishRecordings"; 65 | protected final static String APICALL_UPDATERECORDINGS = "updateRecordings"; 66 | protected final static String APICALL_DELETERECORDINGS = "deleteRecordings"; 67 | protected final static String APICALL_GETCONFIGXML = "getDefaultConfigXML"; 68 | protected final static String APICALL_SETCONFIGXML = "setConfigXML"; 69 | 70 | // API Response Codes 71 | protected final static String APIRESPONSE_SUCCESS = "SUCCESS"; 72 | protected final static String APIRESPONSE_FAILED = "FAILED"; 73 | 74 | // API Versions 75 | public final static String APIVERSION_063 = "0.63"; 76 | public final static String APIVERSION_064 = "0.64"; 77 | public final static String APIVERSION_070 = "0.70"; 78 | public final static String APIVERSION_080 = "0.80"; 79 | public final static String APIVERSION_081 = "0.81"; 80 | public final static String APIVERSION_MINIMUM = APIVERSION_063; 81 | public final static String APIVERSION_LATEST = APIVERSION_081; 82 | 83 | // ----------------------------------------------------------------------- 84 | // --- Initialization related methods ------------------------------------ 85 | // ----------------------------------------------------------------------- 86 | public BaseBBBAPI(String url, String salt) { 87 | this.bbbUrl = url; 88 | 89 | if (bbbUrl.endsWith("/") && bbbUrl.length() > 0) { 90 | bbbUrl = bbbUrl.substring(0, bbbUrl.length() - 1); 91 | } 92 | 93 | this.bbbSalt = salt; 94 | } 95 | 96 | public String getUrl() { 97 | return this.bbbUrl; 98 | } 99 | 100 | /* 101 | public String getSalt() { 102 | return this.bbbSalt; 103 | } 104 | */ 105 | 106 | private String encode(String msg) throws UnsupportedEncodingException { 107 | return URLEncoder.encode(msg, getParametersEncoding()); 108 | } 109 | 110 | // ----------------------------------------------------------------------- 111 | // --- BBB API implementation methods ------------------------------------ 112 | // ----------------------------------------------------------------------- 113 | 114 | /* Create BBB meeting */ 115 | public BBBMeeting createMeeting(final String meetingID) throws BBBException { 116 | return createMeeting(new BBBMeeting(meetingID), null); 117 | } 118 | 119 | public BBBMeeting createMeeting(final BBBMeeting meeting) throws BBBException { 120 | return createMeeting(meeting, null); 121 | } 122 | 123 | public BBBMeeting createMeeting(final BBBMeeting meeting, final BBBModule module) throws BBBException { 124 | try { 125 | StringBuilder query = new StringBuilder(); 126 | query.append("meetingID=" + meeting.getMeetingID()); 127 | if (meeting.getName() != null) 128 | query.append("&name=" + encode(meeting.getName())); 129 | if (meeting.getAttendeePW() != null) 130 | query.append("&attendeePW=" + meeting.getAttendeePW()); 131 | if (meeting.getModeratorPW() != null) 132 | query.append("&moderatorPW=" + meeting.getModeratorPW()); 133 | if (meeting.getWelcome() != null) 134 | query.append("&welcome=" + encode(meeting.getWelcome())); 135 | if (meeting.getDialNumber() != null) 136 | query.append("&dialNumber=" + meeting.getDialNumber()); 137 | if (meeting.getVoiceBridge() != null) 138 | query.append("&voiceBridge=" + meeting.getVoiceBridge()); 139 | if (meeting.getWebVoice() != null) 140 | query.append("&webVoice=" + encode(meeting.getWebVoice())); 141 | if (meeting.getLogoutURL() != null) 142 | query.append("&logoutURL=" + encode(meeting.getLogoutURL())); 143 | if (meeting.getRecord() != null) 144 | query.append("&record=" + Boolean.toString(meeting.getRecord())); 145 | if (meeting.getDuration() != null) 146 | query.append("&duration=" + meeting.getDuration().toString()); 147 | if (!meeting.getMeta().isEmpty()) { 148 | for(Entry entry : meeting.getMeta().entrySet()) { 149 | String key = entry.getKey(); 150 | String value = entry.getValue(); 151 | query.append("&meta_" + key + "="); 152 | query.append(encode(value)); 153 | } 154 | } 155 | if (meeting.getModeratorOnlyMessage() != null) 156 | query.append("&moderatorOnlyMessage=" + encode(meeting.getModeratorOnlyMessage())); 157 | if (meeting.getAutoStartRecording() != null) 158 | query.append("&autoStartRecording=" + Boolean.toString(meeting.getAutoStartRecording())); 159 | if (meeting.getAllowStartStopRecording() != null) 160 | query.append("&allowStartStopRecording=" + Boolean.toString(meeting.getAllowStartStopRecording())); 161 | if (meeting.getWebcamsOnlyForModerator() != null) 162 | query.append("&logo=" + Boolean.toString(meeting.getWebcamsOnlyForModerator())); 163 | if (meeting.getLogo() != null) 164 | query.append("&logo=" + encode(meeting.getLogo())); 165 | if (meeting.getCopyright() != null) 166 | query.append("©right=" + encode(meeting.getCopyright())); 167 | if (meeting.getMuteOnStart() != null) 168 | query.append("&muteOnStart=" + Boolean.toString(meeting.getMuteOnStart())); 169 | query.append(getCheckSumParameterForQuery(APICALL_CREATE, query.toString())); 170 | 171 | Map response = doAPICall(APICALL_CREATE, query.toString(), 172 | module == null ? null : module.to_xml()); 173 | 174 | // capture important information from returned response 175 | meeting.setModeratorPW((String)response.get("moderatorPW")); 176 | meeting.setAttendeePW((String)response.get("attendeePW")); 177 | meeting.setDialNumber((String)response.get("dialNumber")); 178 | meeting.setVoiceBridge((String)response.get("voiceBridge")); 179 | SimpleDateFormat formatter = new SimpleDateFormat("EEE MMM d HH:mm:ss zzz yyyy"); 180 | try { 181 | meeting.setStartDate(formatter.parse((String)response.get("createDate"))); 182 | } catch (ParseException e) { } 183 | 184 | return meeting; 185 | } catch (BBBException e) { 186 | throw e; 187 | } catch (IOException e) { 188 | throw new BBBException(BBBException.MESSAGEKEY_INTERNALERROR, e.getMessage(), e); 189 | } 190 | } 191 | 192 | /* Check if meeting is running */ 193 | public boolean isMeetingRunning(String meetingID) 194 | throws BBBException { 195 | try { 196 | StringBuilder query = new StringBuilder(); 197 | query.append("meetingID=" + meetingID); 198 | query.append(getCheckSumParameterForQuery(APICALL_ISMEETINGRUNNING, query.toString())); 199 | 200 | Map response = doAPICall(APICALL_ISMEETINGRUNNING, query.toString()); 201 | return Boolean.parseBoolean((String) response.get("running")); 202 | } catch (Exception e) { 203 | throw new BBBException(BBBException.MESSAGEKEY_INTERNALERROR, e.getMessage(), e); 204 | } 205 | } 206 | 207 | /* Get list of all running BBB meetings */ 208 | public Map getMeetings() throws BBBException { 209 | try { 210 | StringBuilder query = new StringBuilder(); 211 | query.append(getCheckSumParameterForQuery(APICALL_GETMEETINGS, query.toString())); 212 | Map response = doAPICall(APICALL_GETMEETINGS, query.toString()); 213 | 214 | return response; 215 | } catch (Exception e) { 216 | throw new BBBException(BBBException.MESSAGEKEY_INTERNALERROR, e.getMessage(), e); 217 | } 218 | } 219 | 220 | /* Get BBB meeting information */ 221 | public Map getMeetingInfo(final BBBMeeting meeting) throws BBBException { 222 | return getMeetingInfo(meeting.getMeetingID(), meeting.getModeratorPW()); 223 | } 224 | 225 | public Map getMeetingInfo(String meetingID, String password) 226 | throws BBBException { 227 | try { 228 | StringBuilder query = new StringBuilder(); 229 | query.append("meetingID=" + meetingID); 230 | query.append("&password=" + password); 231 | query.append(getCheckSumParameterForQuery(APICALL_GETMEETINGINFO, query.toString())); 232 | Map response = doAPICall(APICALL_GETMEETINGINFO, query.toString()); 233 | return response; 234 | } catch (BBBException e) { 235 | throw new BBBException(e.getMessageKey(), e.getMessage(), e); 236 | } 237 | } 238 | 239 | /* End given BBB meeting */ 240 | public boolean endMeeting(final BBBMeeting meeting) throws BBBException { 241 | return endMeeting(meeting.getMeetingID(), meeting.getModeratorPW()); 242 | } 243 | 244 | public boolean endMeeting(String meetingID, String password) throws BBBException { 245 | StringBuilder query = new StringBuilder(); 246 | query.append("meetingID=" + meetingID); 247 | query.append("&password=" + password); 248 | query.append(getCheckSumParameterForQuery(APICALL_END, query.toString())); 249 | 250 | try { 251 | doAPICall(APICALL_END, query.toString()); 252 | } catch (BBBException e) { 253 | if(BBBException.MESSAGEKEY_NOTFOUND.equals(e.getMessageKey())) { 254 | // we can safely ignore this one: the meeting is not running 255 | return true; 256 | }else{ 257 | throw e; 258 | } 259 | } 260 | 261 | return true; 262 | } 263 | 264 | /** Get recordings from BBB server */ 265 | public Map getRecordings() throws BBBException { 266 | return getRecordings(null, null, null, null); 267 | } 268 | 269 | public Map getRecordings(String meetingIDs) throws BBBException { 270 | return getRecordings(meetingIDs, null, null, null); 271 | } 272 | 273 | public Map getRecordings(String meetingIDs, String recordIDs) throws BBBException { 274 | return getRecordings(meetingIDs, recordIDs, null, null); 275 | } 276 | 277 | public Map getRecordings(String meetingIDs, String recordIDs, String states) throws BBBException { 278 | return getRecordings(meetingIDs, recordIDs, states, null); 279 | } 280 | 281 | public Map getRecordings(String meetingIDs, String recordIDs, String states, Map meta) throws BBBException { 282 | try { 283 | StringBuilder query = new StringBuilder(); 284 | if (meetingIDs != null) 285 | query.append("meetingID=" + meetingIDs); 286 | if (recordIDs != null) 287 | query.append("recordID=" + recordIDs); 288 | if (states != null) 289 | query.append("state=" + states); 290 | if (meta != null && meta.size() != 0) { 291 | for(Entry entry : meta.entrySet()) { 292 | String key = entry.getKey(); 293 | String value = entry.getValue(); 294 | query.append("&meta_" + key + "="); 295 | query.append(encode(value)); 296 | } 297 | } 298 | query.append(getCheckSumParameterForQuery(APICALL_getRecordS, query.toString())); 299 | Map response = doAPICall(APICALL_getRecordS, query.toString()); 300 | 301 | return response; 302 | } catch (BBBException e) { 303 | throw new BBBException(e.getMessageKey(), e.getMessage(), e); 304 | } catch (IOException e) { 305 | throw new BBBException(BBBException.MESSAGEKEY_INTERNALERROR, e.getMessage(), e); 306 | } 307 | } 308 | 309 | /* Detete a record from BBB server */ 310 | public boolean deteteRecordings(String recordIDs) throws BBBException { 311 | StringBuilder query = new StringBuilder(); 312 | query.append("recordID=" + recordIDs); 313 | query.append(getCheckSumParameterForQuery(APICALL_DELETERECORDINGS, query.toString())); 314 | try { 315 | Map response = doAPICall(APICALL_DELETERECORDINGS, query.toString()); 316 | return response.get("returncode").toString().equals("SUCCESS") ? true : false; 317 | } catch (BBBException e) { 318 | throw e; 319 | } 320 | } 321 | 322 | /* Publish/Unpublish a recording on BBB server */ 323 | public boolean publishRecordings(String recordIDs, boolean publish) throws BBBException { 324 | StringBuilder query = new StringBuilder(); 325 | query.append("recordID=" + recordIDs); 326 | query.append("&publish=" + Boolean.toString(publish)); 327 | query.append(getCheckSumParameterForQuery(APICALL_PUBLISHRECORDINGS, query.toString())); 328 | 329 | try { 330 | Map response = doAPICall(APICALL_PUBLISHRECORDINGS, query.toString()); 331 | return response.get("returncode").toString().equals("SUCCESS") ? true : false; 332 | } catch (BBBException e) { 333 | throw e; 334 | } 335 | } 336 | 337 | /* Update a recording on BBB server */ 338 | public boolean updateRecordings(String recordingIDs) throws BBBException { 339 | return updateRecordings(recordingIDs, null); 340 | } 341 | 342 | public boolean updateRecordings(String recordingIDs, Map meta) throws BBBException { 343 | try { 344 | StringBuilder query = new StringBuilder(); 345 | query.append("recordID=" + recordingIDs); 346 | if (meta != null && meta.size() != 0) { 347 | for(Entry entry : meta.entrySet()) { 348 | String key = entry.getKey(); 349 | String value = entry.getValue(); 350 | query.append("&meta_" + key + "="); 351 | query.append(encode(value)); 352 | } 353 | } 354 | query.append(getCheckSumParameterForQuery(APICALL_UPDATERECORDINGS, query.toString())); 355 | Map response = doAPICall(APICALL_UPDATERECORDINGS, query.toString()); 356 | return response.get("returncode").toString().equals("SUCCESS") ? true : false; 357 | } catch (BBBException e) { 358 | throw e; 359 | } catch (IOException e) { 360 | throw new BBBException(BBBException.MESSAGEKEY_INTERNALERROR, e.getMessage(), e); 361 | } 362 | } 363 | 364 | /* Build the join meeting url based on user role */ 365 | public String getJoinMeetingURL(String meetingID, String password, String userDisplayName) { 366 | return getJoinMeetingURL(meetingID, password, userDisplayName, null); 367 | } 368 | 369 | public String getJoinMeetingURL(String meetingID, String password, String userDisplayName, String userId) { 370 | StringBuilder url = null; 371 | try { 372 | StringBuilder joinQuery = new StringBuilder(); 373 | joinQuery.append("meetingID=" + meetingID); 374 | if (userId != null) 375 | joinQuery.append("&userID=" + encode(userId)); 376 | 377 | joinQuery.append("&fullName="); 378 | userDisplayName = (userDisplayName == null) ? "user" : userDisplayName; 379 | try { 380 | joinQuery.append(encode(userDisplayName)); 381 | } catch (UnsupportedEncodingException e) { 382 | joinQuery.append(userDisplayName); 383 | } 384 | joinQuery.append("&password=" + password); 385 | joinQuery.append(getCheckSumParameterForQuery(APICALL_JOIN, joinQuery.toString())); 386 | 387 | url = new StringBuilder(bbbUrl); 388 | if (url.toString().endsWith("/api")) { 389 | url.append("/"); 390 | } else { 391 | url.append(API_SERVERPATH); 392 | } 393 | url.append(APICALL_JOIN + "?" + joinQuery); 394 | } catch (UnsupportedEncodingException e) { } 395 | return url.toString(); 396 | } 397 | 398 | /* Download default config xml file from the server and save the file to given file location */ 399 | public boolean getDefaultConfigXML(String filePath) throws BBBException { 400 | try { 401 | StringBuilder query = new StringBuilder(); 402 | query.append(getCheckSumParameterForQuery(APICALL_GETCONFIGXML, query.toString())); 403 | Map response = doAPICall(APICALL_GETCONFIGXML, query.toString()); 404 | 405 | File file = new File(filePath); 406 | if (file.exists() && !file.canWrite()) { 407 | throw new IOException("Failed to edit " + filePath); 408 | } else if (!file.exists()) { 409 | if (!file.createNewFile()) 410 | throw new IOException("Failed to create " + filePath); 411 | } 412 | 413 | FileOutputStream output = new FileOutputStream(file); 414 | output.write(((String)response.get("xml")).getBytes()); 415 | output.close(); 416 | return true; 417 | } catch (BBBException e) { 418 | throw e; 419 | } catch (IOException e) { 420 | throw new BBBException(BBBException.MESSAGEKEY_INTERNALERROR, e.getMessage(), e); 421 | } 422 | } 423 | 424 | /* set the config.xml file for the given meeting */ 425 | public boolean setConfigXML(String meetingID, String filePath) throws BBBException { 426 | try { 427 | StringBuilder query = new StringBuilder(); 428 | query.append("meetingID=" + meetingID); 429 | query.append(getCheckSumParameterForQuery(APICALL_SETCONFIGXML, query.toString())); 430 | 431 | File file = new File(filePath); 432 | if (!file.exists() || !file.canRead()) { 433 | throw new IOException("Failed to read " + filePath); 434 | } 435 | 436 | FileInputStream input = new FileInputStream(file); 437 | byte[] b = input.readAllBytes(); 438 | input.close(); 439 | String xml = ""; 440 | for (byte a : b) 441 | xml += (char)a; 442 | query.append("&configXML=" + encode(xml)); 443 | 444 | Map response = doAPICall(APICALL_SETCONFIGXML, query.toString()); 445 | return response.get("returncode").toString().equals("SUCCESS") ? true : false; 446 | } catch (BBBException e) { 447 | throw e; 448 | } catch (IOException e) { 449 | throw new BBBException(BBBException.MESSAGEKEY_INTERNALERROR, e.getMessage(), e); 450 | } 451 | } 452 | 453 | /** Get the BBB API version running on BBB server */ 454 | public final String getAPIVersion() { 455 | String _version = null; 456 | try { 457 | Map response = doAPICall(APICALL_VERSION, null); 458 | _version = (String) response.get("version"); 459 | _version = _version != null ? _version.trim() : null; 460 | if (_version == null || Float.valueOf(_version.substring(0, 3)) < 0.0) { 461 | _version = null; 462 | } 463 | _version = _version.trim(); 464 | } catch (BBBException e) { 465 | if (BBBException.MESSAGEKEY_NOACTION.equals(e.getMessageKey())) { 466 | // we are clearly connecting to BBB < 0.70 => assuming minimum 467 | // version (0.63) 468 | _version = APIVERSION_MINIMUM; 469 | } else { 470 | // something went wrong => warn user 471 | _version = null; 472 | } 473 | } catch (Exception e) { 474 | // something went wrong => warn user 475 | _version = null; 476 | } 477 | return _version; 478 | } 479 | 480 | // ----------------------------------------------------------------------- 481 | // --- BBB API utility methods ------------------------------------------- 482 | // ----------------------------------------------------------------------- 483 | /** Compute the query string checksum based on the security salt */ 484 | protected String getCheckSumParameterForQuery(String apiCall, 485 | String queryString) { 486 | if (bbbSalt != null) 487 | return "&checksum=" + DigestUtils.shaHex(apiCall + queryString + bbbSalt); 488 | else 489 | return ""; 490 | } 491 | 492 | /** Encoding used when encoding url parameters */ 493 | protected String getParametersEncoding() { 494 | return "UTF-8"; 495 | } 496 | 497 | 498 | /* Make an API call */ 499 | protected Map doAPICall(String apiCall, String query) throws BBBException { 500 | return doAPICall(apiCall, query, null); 501 | } 502 | 503 | protected Map doAPICall(String apiCall, String query, String data) throws BBBException { 504 | StringBuilder urlStr = new StringBuilder(bbbUrl); 505 | if (urlStr.toString().endsWith("/api")){ 506 | urlStr.append("/"); 507 | } else { 508 | urlStr.append(API_SERVERPATH); 509 | } 510 | urlStr.append(apiCall); 511 | if (query != null) { 512 | urlStr.append("?"); 513 | urlStr.append(query); 514 | } 515 | 516 | try { 517 | // open connection 518 | URL url = new URL(urlStr.toString()); 519 | HttpURLConnection httpConnection = (HttpURLConnection) url.openConnection(); 520 | httpConnection.setUseCaches(false); 521 | httpConnection.setDoOutput(true); 522 | if(data != null){ 523 | httpConnection.setRequestMethod("POST"); 524 | httpConnection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); 525 | httpConnection.setRequestProperty("Content-Length", "" + data.length()); 526 | httpConnection.setRequestProperty("Content-Language", "en-US"); 527 | httpConnection.setDoInput(true); 528 | 529 | DataOutputStream wr = new DataOutputStream( httpConnection.getOutputStream() ); 530 | wr.writeBytes (data); 531 | wr.flush(); 532 | wr.close(); 533 | } else { 534 | httpConnection.setRequestMethod("GET"); 535 | } 536 | httpConnection.connect(); 537 | 538 | int responseCode = httpConnection.getResponseCode(); 539 | if (responseCode == HttpURLConnection.HTTP_OK) { 540 | // read response 541 | InputStreamReader isr = null; 542 | BufferedReader reader = null; 543 | StringBuilder xml = new StringBuilder(); 544 | try { 545 | isr = new InputStreamReader(httpConnection.getInputStream(), "UTF-8"); 546 | reader = new BufferedReader(isr); 547 | String line = reader.readLine(); 548 | while (line != null) { 549 | if( !line.startsWith("")) 550 | xml.append(line.trim()); 551 | line = reader.readLine(); 552 | } 553 | } finally { 554 | if (reader != null) 555 | reader.close(); 556 | if (isr != null) 557 | isr.close(); 558 | } 559 | httpConnection.disconnect(); 560 | 561 | // parse response 562 | //Patch to fix the NaN error 563 | String stringXml = xml.toString(); 564 | stringXml = stringXml.replaceAll(">.\\s+?<", "><"); 565 | 566 | if (apiCall.equals(APICALL_GETCONFIGXML)) { 567 | Map map = new HashMap(); 568 | map.put("xml", stringXml); 569 | return map; 570 | } 571 | 572 | Document dom = null; 573 | 574 | // Initialize XML libraries 575 | DocumentBuilderFactory docBuilderFactory; 576 | DocumentBuilder docBuilder; 577 | docBuilderFactory = DocumentBuilderFactory.newInstance(); 578 | try { 579 | docBuilderFactory.setFeature("http://xml.org/sax/features/external-general-entities", false); 580 | docBuilderFactory.setFeature("http://xml.org/sax/features/external-parameter-entities", false); 581 | 582 | docBuilder = docBuilderFactory.newDocumentBuilder(); 583 | dom = docBuilder.parse(new InputSource( new StringReader(stringXml))); 584 | } catch (ParserConfigurationException e) { } 585 | Map response = getNodesAsMap(dom, "response"); 586 | 587 | String returnCode = (String) response.get("returncode"); 588 | if (APIRESPONSE_FAILED.equals(returnCode)) { 589 | throw new BBBException((String) response.get("messageKey"), (String) response.get("message")); 590 | } 591 | 592 | return response; 593 | } else { 594 | throw new BBBException(BBBException.MESSAGEKEY_HTTPERROR, "BBB server responded with HTTP status code " + responseCode); 595 | } 596 | 597 | } catch(BBBException e) { 598 | throw new BBBException( e.getMessageKey(), e.getMessage(), e); 599 | } catch(IOException e) { 600 | throw new BBBException(BBBException.MESSAGEKEY_UNREACHABLE, e.getMessage(), e); 601 | } catch(SAXException e) { 602 | throw new BBBException(BBBException.MESSAGEKEY_INVALIDRESPONSE, e.getMessage(), e); 603 | } catch(IllegalArgumentException e) { 604 | throw new BBBException(BBBException.MESSAGEKEY_INVALIDRESPONSE, e.getMessage(), e); 605 | } catch(Exception e) { 606 | throw new BBBException(BBBException.MESSAGEKEY_UNREACHABLE, e.getMessage(), e); 607 | } 608 | } 609 | 610 | 611 | // ----------------------------------------------------------------------- 612 | // --- BBB Other utility methods ----------------------------------------- 613 | // ----------------------------------------------------------------------- 614 | /** Get all nodes under the specified element tag name as a Java map */ 615 | protected Map getNodesAsMap(Document dom, String elementTagName) { 616 | Node firstNode = dom.getElementsByTagName(elementTagName).item(0); 617 | return processNode(firstNode); 618 | } 619 | 620 | protected Map processNode(Node _node) { 621 | Map map = new HashMap(); 622 | NodeList responseNodes = _node.getChildNodes(); 623 | int images = 1; //counter for images (i.e image1, image2, image3) 624 | for (int i = 0; i < responseNodes.getLength(); i++) { 625 | Node node = responseNodes.item(i); 626 | String nodeName = node.getNodeName().trim(); 627 | if (node.getChildNodes().getLength() == 1 628 | && ( node.getChildNodes().item(0).getNodeType() == org.w3c.dom.Node.TEXT_NODE || node.getChildNodes().item(0).getNodeType() == org.w3c.dom.Node.CDATA_SECTION_NODE) ) { 629 | String nodeValue = node.getTextContent(); 630 | if (nodeName == "image" && node.getAttributes() != null){ 631 | Map imageMap = new HashMap(); 632 | Node heightAttr = node.getAttributes().getNamedItem("height"); 633 | Node widthAttr = node.getAttributes().getNamedItem("width"); 634 | Node altAttr = node.getAttributes().getNamedItem("alt"); 635 | 636 | imageMap.put("height", heightAttr.getNodeValue()); 637 | imageMap.put("width", widthAttr.getNodeValue()); 638 | imageMap.put("title", altAttr.getNodeValue()); 639 | imageMap.put("url", nodeValue); 640 | map.put(nodeName + images, imageMap); 641 | images++; 642 | } else { 643 | map.put(nodeName, nodeValue != null ? nodeValue.trim() : null); 644 | } 645 | } else if (node.getChildNodes().getLength() == 0 646 | && node.getNodeType() != org.w3c.dom.Node.TEXT_NODE 647 | && node.getNodeType() != org.w3c.dom.Node.CDATA_SECTION_NODE) { 648 | map.put(nodeName, ""); 649 | } else if (node.getChildNodes().getLength() >= 1) { 650 | boolean isList = false; 651 | for (int c = 0; c < node.getChildNodes().getLength(); ++c) { 652 | try { 653 | Node n = node.getChildNodes().item(c); 654 | if (n.getChildNodes().item(0).getNodeType() != org.w3c.dom.Node.TEXT_NODE 655 | && n.getChildNodes().item(0).getNodeType() != org.w3c.dom.Node.CDATA_SECTION_NODE) { 656 | isList = true; 657 | break; 658 | } 659 | } catch (Exception e) { 660 | continue; 661 | } 662 | } 663 | List list = new ArrayList(); 664 | if (isList) { 665 | for (int c = 0; c < node.getChildNodes().getLength(); ++c) { 666 | Node n = node.getChildNodes().item(c); 667 | list.add(processNode(n)); 668 | } 669 | if (nodeName == "preview"){ 670 | Node n = node.getChildNodes().item(0); 671 | map.put(nodeName, new ArrayList(processNode(n).values())); 672 | } else { 673 | map.put(nodeName, list); 674 | } 675 | } else { 676 | map.put(nodeName, processNode(node)); 677 | } 678 | } else { 679 | map.put(nodeName, processNode(node)); 680 | } 681 | } 682 | return map; 683 | } 684 | } 685 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------