├── .gitignore ├── .gitmodules ├── CODE_OF_CONDUCT.md ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # macOS 2 | .DS_Store 3 | 4 | /Sources/Android/EventTracing-Android/* 5 | /Sources/Android/EventTracing-iOS/* 6 | /Sources/Android/EventTracing-iOS-Debug/* 7 | /Sources/Android/EventTracing-iOS-LogViewer/* 8 | /Sources/H5/EventTracing-web/* 9 | /Sources/H5/EventTracing-web/* 10 | /Sources/easyinsight/easyinsight-server/* 11 | /Sources/easyinsight/easyinsight-web/* -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "Sources/iOS/EventTracing-iOS"] 2 | path = Sources/iOS/EventTracing-iOS 3 | url = git@github.com:eventtracing/EventTracing-iOS.git 4 | [submodule "Sources/iOS/EventTracing-iOS-Debug"] 5 | path = Sources/iOS/EventTracing-iOS-Debug 6 | url = git@github.com:eventtracing/EventTracing-iOS-Debug.git 7 | [submodule "Sources/iOS/EventTracing-iOS-LogViewer"] 8 | path = Sources/iOS/EventTracing-iOS-LogViewer 9 | url = git@github.com:eventtracing/EventTracing-iOS-LogViewer.git 10 | [submodule "Sources/Android/EventTracing-Android"] 11 | path = Sources/Android/EventTracing-Android 12 | url = git@github.com:eventtracing/EventTracing-Android.git 13 | [submodule "Sources/H5/EventTracing-web"] 14 | path = Sources/H5/EventTracing-web 15 | url = git@github.com:eventtracing/EventTracing-web.git 16 | url = git@github.com:eventtracing/easyinsight-web.git 17 | [submodule "Sources/easyinsight/easyinsight-server"] 18 | path = Sources/easyinsight/easyinsight-server 19 | url = git@github.com:eventtracing/easyinsight-server.git 20 | [submodule "Sources/easyinsight/easyinsight-front"] 21 | path = Sources/easyinsight/easyinsight-front 22 | url = git@github.com:eventtracing/easyinsight-front.git 23 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, caste, color, religion, or sexual 10 | identity and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the overall 26 | community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or advances of 31 | any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email address, 35 | without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | firstcontributions@gmail.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series of 86 | actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or permanent 93 | ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within the 113 | community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.1, available at 119 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. 120 | 121 | Community Impact Guidelines were inspired by 122 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. 123 | 124 | For answers to common questions about this code of conduct, see the FAQ at 125 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at 126 | [https://www.contributor-covenant.org/translations][translations]. 127 | 128 | [homepage]: https://www.contributor-covenant.org 129 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html 130 | [Mozilla CoC]: https://github.com/mozilla/diversity 131 | [FAQ]: https://www.contributor-covenant.org/faq 132 | [translations]: https://www.contributor-covenant.org/translations 133 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [![version](https://img.shields.io/badge/dawn-v1.0.0-yellow)]() 4 |
5 | [![version](https://img.shields.io/badge/EventTracing-iOS-green)]() 6 | [![version](https://img.shields.io/badge/EventTracing-Android-green)]() 7 | [![version](https://img.shields.io/badge/EventTracing-web-green)]() 8 |
9 | [![version](https://img.shields.io/badge/easyinsight-server-blue)]() 10 | [![version](https://img.shields.io/badge/easyinsight-front-blue)]() 11 | 12 | # 曙光 13 | 14 | **曙光埋点** 是一套全链路埋点方案，从埋点设计、到客户端三端(iOS、Android、H5)开发、以及埋点校验&稽查、再到埋点数据使用，目前已经广泛应用于云音乐各个主要APP，它集自动化埋点与全链路追踪等特点于一身，近乎完美地解决了传统埋点的所有痛点，兼顾了开发效率与埋点数据的高精度特点。 15 | 16 | [云音乐曙光埋点：还原数据理想国](https://mp.weixin.qq.com/s/4Wq4nj-oQPohMqmQv_Pe9g) 17 | 18 | ## 为什么用曙光 19 | 20 | 相比同类竞品的方案，曙光埋点有如下优势 21 | 22 | - **规范化**: 客户端开发时，格式、参数(公共参数、SDK保留参数、参数类型/格式等)、**埋点时机**，双端规范统一化，可无缝对接H5、RN等 23 | - **链路追踪**: 全链路级别的链路追踪能力，助力绘制用户画像，满足你漏斗分析、个性化推荐、实时分析、离线分析 24 | - **对象化-虚拟树VTree**: 从埋点录入人员，到客户端埋点开发人员，我们面向的是一个个的对象 25 | - **埋点数据管理**: 埋点虚拟树、埋点对象的可视化管理，涵盖着多版本并行开发管理，告别埋点管理混乱 26 | - **埋点校验&稽查**: 线下埋点校验，和线上埋点稽查，同时配备了可供开发/测试方便的客户端层面的可视化工具，保障埋点质量 27 | 28 | ## 曙光包含哪些 29 | - iOS SDK 30 | - Android SDK 31 | - H5 SDK（可用于站内/站外） 32 | - Easyinsight埋点管理平台 33 | 34 | ## 工程介绍 35 | 36 | 这个是一个容器级别的壳子工程，以 git submodule 的形式管理其他子项目，子项目包括如下： 37 | 38 | - **iOS SDK**: [EventTracing-iOS](https://github.com/eventtracing/EventTracing-iOS), Debug工具 [EventTracing-iOS-Debug](https://github.com/eventtracing/EventTracing-iOS-Debug), 埋点校验工具 [EventTracing-iOS-LogViewer](https://github.com/eventtracing/EventTracing-iOS-LogViewer) 39 | - **Android SDK**: [EventTracing-Android](https://github.com/eventtracing/EventTracing-Android) 40 | - **H5 SDK**: [EventTracing-web](https://github.com/eventtracing/EventTracing-web) 41 | - **埋点平台 easyinsight-server**: [easyinsight-server](https://github.com/eventtracing/easyinsight-server) 42 | - **埋点平台 easyinsight-front**: [easyinsight-front](https://github.com/eventtracing/easyinsight-front) 43 | 44 | ## iOS & Android端侧SDK特点 45 | ### 轻量 46 | 47 | 曙光端侧SDK非常轻量，代码里只有数千行，对APP包体积占用非常小，对原有业务也不会增加额外的负担，这一点在云音乐等业内非常成熟的产品环境得到有力验证。它的接入也十分简单，您只需要根据下述文档即可在很短时间内完成功能的接入与使用。 48 | 49 | ### 自动埋点 50 | 51 | 曙光支持常见事件的自动打点，包括`点击`、`曝光`、`滚动`等。 52 | ![event product](https://user-images.githubusercontent.com/121547934/217256651-38c9aba7-4f0f-4cc2-af3e-200883ffdffa.png) 53 | 54 | ### 链路追踪 55 | 56 | 几乎全自动的链接追踪，开发人员几乎不需要额外的工作，强大又简单。 有关链接跟踪原理的更多介绍，请参阅以下文档 57 | **[Link Tracking Introduction](https://eventtracing.github.io/docs/category/%E9%93%BE%E8%B7%AF%E8%BF%BD%E8%B8%AA)** 58 | 59 | ### 模块架构 60 | ![arch](https://user-images.githubusercontent.com/121547934/217257118-ec2e7658-7093-474a-811d-ee173a7e607e.png) 61 | 62 | ## 使用曙光 63 | 64 | - **[官方Demo](https://eventtracing.github.io/docs/category/%E5%AE%98%E6%96%B9demo)** 包含常见场景的使用演示，以及丰富的单元测试 65 | - **[快速开始](https://eventtracing.github.io/docs/category/%E5%AE%98%E6%96%B9demo)** 包含基本场景的SDK接入，以及简单场景的使用 66 | - **[曙光接入](https://eventtracing.github.io/docs/category/%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B)** 包含详细的接入手册，以及各项能力解析 67 | - SDK的详细使用，参见 [iOS SDK详细使用](https://eventtracing.github.io/docs/category/ios)，[Android SDK详细使用](https://eventtracing.github.io/docs/category/android)，[H5 SDK详细使用](https://eventtracing.github.io/docs/category/h5--rn) 68 | 69 | ### 全局配置 70 | 71 | #### 引入 SDK 72 | 73 | > iOS 74 | 75 | **使用 cocoapods 接入** 76 | 77 | ```ruby 78 | # 埋点SDK 79 | pod 'EventTracing-iOS' 80 | 81 | # 调试工具 82 | pod 'EventTracing-iOS-Debug', :configurations => ["Debug"] 83 | # 埋点校验工具 84 | pod 'EventTracing-iOS-LogViewer', :configurations => ["Debug"] 85 | ``` 86 | 87 | > Android 88 | 89 | **build.gradle(project)** 90 | 91 | ```groovy 92 | buildscript { 93 | repositories { 94 | ........ 95 | maven { 96 | url './repo' 97 | } 98 | } 99 | dependencies { 100 | ....... 101 | classpath "com.netease.cloudmusic.plugin:datareport-plugin:1.0.0" 102 | } 103 | } 104 | ``` 105 | 106 | **build.gradle(app)** 107 | 108 | ```groovy 109 | ...... 110 | apply plugin: 'datareport-plugin' 111 | 112 | dataReportConfig { 113 | targetPackages = ['androidx/appcompat', 'androidx/recyclerview/widget', 'androidx/viewpager/widget','com/netease/datareport/demo'] 114 | excludePackages = [] 115 | openDebugLog = true 116 | } 117 | 118 | dependencies { 119 | ...... 120 | implementation project(':datareport') 121 | implementation project(':datareport_debug') 122 | } 123 | ``` 124 | 125 | #### SDK 初始化 126 | 127 | 曙光埋点的启动十分简单，您只需要在APP启动时的合适时机（比如 `didFinishLaunch`加入如下代码，进行一些简单配置，即可完成SDK的启动 128 | 129 | > iOS 130 | ```objc 131 | [[EventTracingEngine sharedInstance] startWithContextBuilder:^(id _Nonnull builder) { 132 | // output channel 133 | [builder addOutputChannel:self]; 134 | }]; 135 | ``` 136 | > Android 137 | ```java 138 | DataReport.getInstance().init(DataReportInner.getInstance(), context,Configuration.builder() //进行一些设置 139 | .build()) 140 | ``` 141 | 142 | > H5 143 | ```javascript 144 | Dawn.init({ 145 | ... // 其他参数 146 | reportLogs: ({ logs }) => { 147 | // 发送 http 请求或通过客户端协议上报 logs 148 | }, 149 | }); 150 | ``` 151 | 152 | ### 设置节点 oid (Object ID) 153 | 154 | - 启动SDK后，需要将目标元素设置上合适的oid，oid的类型分为2种：`page` 和 `element` 155 | - 这取决于BI对节点如何定义，一般来说某个独立的 `XXViewController`建议配置为 `xx_page`的页面节点类型 156 | - 而 `按钮、UI组件`等适合设置为 `xx_btn` `xx_cell`的element节点。 157 | 158 | 但是每个页面的**顶层节点**必须被设置为**page节点**，并且它默认情况下会自动成为**根节点** 159 | 160 | > ***这里涉及了多个关键名词，比如oid, page节点, 根节点等，相关解释在 [关键概念](https://eventtracing.github.io/docs/About/Keyworks), [以及文档](https://eventtracing.github.io/docs/QuickStart/iOS#%E8%AE%BE%E7%BD%AE%E8%8A%82%E7%82%B9-oid)*** 161 | 162 | 163 | **设置 page 节点** 164 | 165 | > 可以给 UIViewController 设置 page 节点，等价于给 vc.view 设置 166 | 167 | > iOS 168 | 169 | ```objc 170 | /* The following two methods are equivalent */ 171 | // Set page node for vc 172 | [EventTracingBuilder viewController:self pageId:@"page_list"]; 173 | // set page node for view 174 | [EventTracingBuilder view:vc. view pageId:@"page_list"]; 175 | ``` 176 | > Android 177 | ```java 178 | NodeBuilder.getNodeBuilder(Activity).setPageId("pageId") 179 | ``` 180 | 181 | > H5 182 | ```javascript 183 | export default () => { 184 | return ( 185 |
192 |
193 | ); 194 | }; 195 | ``` 196 | 197 | **设置 element 节点** 198 | 199 | > iOS 200 | ```objc 201 | // Set the view as an element node 202 | [[EventTracingBuilder view:self.tableView elementId:@"auto_impress_test_list"] build:^(id _Nonnull builder) { 203 | builder 204 | // Exposure start, exposure end, click, etc. will be automatically checked 205 | .buildinEventLogDisableStrategy(ETNodeBuildinEventLogDisableStrategyNone) 206 | // Set an object parameter, all buried points generated by the object will carry this parameter 207 | .params.set(@"auto_key", @"auto_val_123"); 208 | }]; 209 | ``` 210 | 211 | > Android 212 | ```java 213 | NodeBuilder.getNodeBuilder(view).setElementId("elementId") 214 | .setVisibleMargin(10, -10, 0, 0) 215 | .setReportPolicy(ReportPolicy.REPORT_POLICY_EXPOSURE) 216 | .params() 217 | .putBIPosition(2) 218 | .putBITitle("xxx") 219 | .putBICustomParam("xxx", "xxx") 220 | ``` 221 | 222 | > H5 223 | ```javascript 224 | export default () => { 225 | return ( 226 |
232 |
233 | ); 234 | }; 235 | ``` 236 | 237 | ### 自动打点 238 | 239 | **一些内置事件列表** 240 | 241 | 支持的自动打点事件包括: 242 | 243 | - **曝光**：默认开启，分为页面曝光(`_pv`)和元素曝光(`_ev`) 244 | - **点击**：默认开启，元素被点击 `_ec` 245 | - **结束曝光**：默认关闭，页面曝光结束(`_pd`)和元素曝光结束(`_ed`) 246 | - **冷启动**：默认开启，`_ac` 247 | - **进入前台**：默认开启，`_ai` 248 | - **进入后台**：默认开启，`_ao` 249 | - **滚动**：默认关闭，列表视图滚动 `_es` 250 | 251 | **手动打点** 252 | 253 | 以上事件即支持自动打点，也支持手动触发打点，比如下方代码演示了如何手动触发1次 点击事件 `_ec` 254 | 255 | > iOS 256 | ```objc 257 | [EventTracingBuilder logWithView:view event:^(id _Nonnull builder) { 258 | builder.ec(); 259 | }]; 260 | ``` 261 | 262 | > Android 263 | ```java 264 | DataReporter.clickBI() 265 | .setTarget(view) 266 | .setParam("xx", "xx") 267 | .report() 268 | ``` 269 | 270 | > H5 271 | ```javascript 272 | window.NE_DAWN.trigger(target, options); 273 | ``` 274 | 275 | ### 可视化调试工具 276 | 277 | - 为了更方便地进行本地埋点调试，我们开发了专门的埋点可视化调试工具 278 | - 工具的相关用法见文档 [iOS](https://eventtracing.github.io/docs/iOS/debug_tools), [Android](https://eventtracing.github.io/docs/Android/debug_tools) 279 | 280 | > 比如 iOS 可视化调试工具的截图 281 | 282 | ![image](https://user-images.githubusercontent.com/121547934/217413196-0e1141ae-f5d0-4ea6-beaf-051c2b01d248.png) 283 | 284 | ### 埋点实时校验工具 285 | 286 | - 为了更方便地进行本地埋点校验，我们跟平台一起对接，做了埋点实时校验工具 287 | - 工具的相关用法见文档 [iOS](https://eventtracing.github.io/docs/iOS/debug_tools), [Android](https://eventtracing.github.io/docs/Android/debug_tools) 288 | 289 | ## 开发者共建 290 | 291 | 欢迎广大开发者一起来添砖加瓦！下面是一些方式来更好的一起参与共建： 292 | 293 | - **提Bugs，以及发现新需求**，你可以提 [issue](https://github.com/eventtracing/dawn/issues) 294 | - **开发者贡献**：如果你有兴趣一起参与共建，可以先看下 以及开发者宣言 [code of conduct](https://github.com/eventtracing/dawn/blob/master/CODE_OF_CONDUCT.md) 以及 [开发者建议](https://eventtracing.github.io/docs/Contributing/intro) 295 | 296 | ## 一起探讨 297 | 298 | 你可以通过 [Discussions](https://github.com/eventtracing/dawn/discussions) 跟我们一起讨论 299 | 300 | 也可以加入到我们的 [slack工作区](https://join.slack.com/t/dawn-sva3699/shared_invite/zt-1r42giro6-lWTTfbRAqpwsvYthYDRC3A) 301 | 302 | 或者添加下方微信，申请加入我们的官方微信群： 303 | ![image](https://github.com/eventtracing/dawn/assets/11256461/98b04686-338a-4562-aafa-2a7aebdf6472) 304 | 305 | 306 | ## License 307 | 了解更多参见 [LICENSE](./LICENSE) 308 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | --------------------------------------------------------------------------------