├── Makefile ├── example.env ├── docker-compose.yaml ├── .gitignore ├── app.go ├── go.mod ├── add_users.sh ├── config.go ├── README.md ├── main.go └── LICENSE.txt /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: run 2 | 3 | # Golang Flags 4 | GOFLAGS ?= $(GOFLAGS:) 5 | GO=go 6 | 7 | run: 8 | $(GO) run $(GOFLAGS) $(GO_LINKER_FLAGS) *.go 9 | -------------------------------------------------------------------------------- /example.env: -------------------------------------------------------------------------------- 1 | MM_TEAM="botsample" 2 | MM_TOKEN="XXXXXXXXXXXXXXX" 3 | MM_CHANNEL="town-square" 4 | MM_SERVER="http://localhost:8065" 5 | MM_USERNAME="samplebot" 6 | -------------------------------------------------------------------------------- /docker-compose.yaml: -------------------------------------------------------------------------------- 1 | version: "3.9" 2 | services: 3 | test_mm: 4 | image: mattermost/mattermost-preview 5 | container_name: test_mm 6 | ports: 7 | - "8065:8065" 8 | environment: 9 | MM_SERVICESETTINGS_ENABLELOCALMODE: "true" -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | logs 3 | .DS_Store 4 | 5 | # Build Targets 6 | .prebuild 7 | .npminstall 8 | 9 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 10 | *.o 11 | *.a 12 | *.so 13 | 14 | # Folders 15 | _obj 16 | _test 17 | 18 | # Log files 19 | *mattermost.log 20 | *npm-debug.log* 21 | 22 | .tmp 23 | 24 | # Vim temporary files 25 | [._]*.s[a-w][a-z] 26 | [._]s[a-w][a-z] 27 | *.un~ 28 | Session.vim 29 | .netrwhist 30 | *~ 31 | 32 | .agignore 33 | .ctags 34 | tags 35 | 36 | .env 37 | -------------------------------------------------------------------------------- /app.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "github.com/mattermost/mattermost-server/v6/model" 5 | "github.com/rs/zerolog" 6 | ) 7 | 8 | // application struct to hold the dependencies for our bot 9 | type application struct { 10 | config config 11 | logger zerolog.Logger 12 | mattermostClient *model.Client4 13 | mattermostWebSocketClient *model.WebSocketClient 14 | mattermostUser *model.User 15 | mattermostChannel *model.Channel 16 | mattermostTeam *model.Team 17 | } 18 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/mattermost/mattermost-bot-sample-golang 2 | 3 | go 1.15 4 | 5 | require ( 6 | github.com/joho/godotenv v1.4.0 7 | github.com/klauspost/compress v1.15.2 // indirect 8 | github.com/mattermost/ldap v3.0.4+incompatible // indirect 9 | github.com/mattermost/mattermost-server/v6 v6.7.2 10 | github.com/pelletier/go-toml v1.9.5 // indirect 11 | github.com/rs/zerolog v1.15.0 12 | golang.org/x/crypto v0.0.0-20220427172511-eb4f295cb31f // indirect 13 | golang.org/x/net v0.0.0-20220425223048-2871e0cb64e4 // indirect 14 | golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6 // indirect 15 | gopkg.in/asn1-ber.v1 v1.0.0-20181015200546-f715ec2f112d // indirect 16 | ) 17 | -------------------------------------------------------------------------------- /add_users.sh: -------------------------------------------------------------------------------- 1 | USER_EMAIL="bill@example.com" 2 | USER_PASS="Password1!" 3 | USER_NAME="bill" 4 | docker exec test_mm bash -c 'until mmctl --local system status 2> /dev/null; do echo "waiting for server to become available"; sleep 5; done' 5 | docker exec test_mm mmctl --local team create --name botsample display_name "Sample Bot playground" --email "admin@example.com" 6 | docker exec test_mm mmctl --local user create --email="${USER_EMAIL}" --password="${USER_PASS}" --username="${USER_NAME}" 7 | docker exec test_mm mmctl --local roles system_admin bill 8 | docker exec test_mm mmctl --local team users add botsample bill 9 | 10 | echo "Default user credentials" 11 | echo "Email: ${USER_EMAIL} - Password: ${USER_PASS}" 12 | -------------------------------------------------------------------------------- /config.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "net/url" 5 | "os" 6 | 7 | _ "github.com/joho/godotenv/autoload" 8 | ) 9 | 10 | type config struct { 11 | mattermostUserName string 12 | mattermostTeamName string 13 | mattermostToken string 14 | mattermostChannel string 15 | mattermostServer *url.URL 16 | } 17 | 18 | func loadConfig() config { 19 | var settings config 20 | 21 | settings.mattermostTeamName = os.Getenv("MM_TEAM") 22 | settings.mattermostUserName = os.Getenv("MM_USERNAME") 23 | settings.mattermostToken = os.Getenv("MM_TOKEN") 24 | settings.mattermostChannel = os.Getenv("MM_CHANNEL") 25 | settings.mattermostServer, _ = url.Parse(os.Getenv("MM_SERVER")) 26 | 27 | return settings 28 | } 29 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Mattermost Bot Sample 2 | 3 | ## Overview 4 | 5 | This sample Bot shows how to use the Mattermost [Go driver](https://github.com/mattermost/mattermost-server/blob/master/model/client4.go) to interact with a Mattermost server, listen to events and respond to messages. Documentation for the Go driver can be found [here](https://pkg.go.dev/github.com/mattermost/mattermost-server/v6/model). 6 | 7 | Highlights of APIs used in this sample: 8 | 9 | - Log in to the Mattermost server 10 | - Create a channel 11 | - Modify user attributes 12 | - Connect and listen to WebSocket events for real-time responses to messages 13 | - Post a message to a channel 14 | 15 | This Bot Sample was tested with Mattermost server version 7.5.2. 16 | 17 | ## Setup Server Environment 18 | 19 | ### Via Docker And Docker-Compose 20 | 21 | 1 - Ensure [Docker](https://www.docker.com/get-started) and [Docker-Compose](https://docs.docker.com/compose/install/) are installed on your system. 22 | 23 | 2 - Run `docker-compose up -d --build` and the mattermost client will be built and will expose the port `8065` to your system's localhost. 24 | 25 | 3 - Run `./add_users.sh`. The login information for the Mattermost client will be printed. 26 | 27 | 4 - Log into your mattermost instance using these credentials and create a bot account following [these](https://developers.mattermost.com/integrate/reference/bot-accounts/) instructions. 28 | 29 | 5 - Copy `example.env` to `.env` and fill in the bot token (obtained from the previous step), team name, etc. Alternatively, just provide your credentials as environment variables. 30 | 31 | 5 - Start the Bot. 32 | 33 | ``` 34 | make run 35 | ``` 36 | 37 | You can verify the Bot is running when 38 | 39 | - `Logged in to mattermost` appears on the command line. 40 | - `Hi! I am a bot.` is posted in your specified channel. 41 | 42 | See "Test the Bot" for testing instructions 43 | 44 | ### Via Direct System Install/Setup 45 | 46 | 1 - [Install](http://docs.mattermost.com/install/requirements.html) or [upgrade](https://docs.mattermost.com/administration/upgrade.html) to Mattermost server version 3.10+, and verify that the Mattermost server is running on [http://localhost:8065](http://localhost:8065). 47 | 48 | On the commands below, if you are running Mattermost server version 5.0 or later, use `./bin/mmctl`. If you are running version 4.10 or earlier, use `./bin/platform`. 49 | 50 | Learn more about the `mmctl` CLI tool in the [Mattermost documentation](https://docs.mattermost.com/administration/mmctl-cli-tool.html). 51 | 52 | 2 - Create a team for the Bot to run. If you have an existing team, you may skip this step and replace `botsample` with your existing team in subsequent steps. 53 | 54 | ``` 55 | ./bin/mmctl team create --name botsample --display_name "Sample Bot playground" --email "admin@example.com" 56 | ``` 57 | 58 | 3 - Create a user, `bill`, which we will use to log in and interact with the Bot. 59 | 60 | ``` 61 | ./bin/mmctl user create --email="bill@example.com" --password="Password1!" --username="bill" 62 | ``` 63 | 64 | 4 - (Optional) Give `bill` `system_admin` permissions. 65 | 66 | ``` 67 | ./bin/mmctl roles system_admin bill 68 | ``` 69 | 70 | 5 - Log in to [http://localhost:8065](http://localhost:8065) as `bill` and verify the account was created successfully. 71 | 72 | 6 - Create a bot account following [these](https://developers.mattermost.com/integrate/reference/bot-accounts/) instructions. 73 | 74 | 7 - Copy `example.env` to `.env` and fill in the bot token (obtained from the previous step), team name, etc. Alternatively, just provide your credentials as environment variables. 75 | 76 | ## Setup Bot Development Environment 77 | 78 | 1 - Follow the [Developer Machine Setup](https://docs.mattermost.com/developer/dev-setup.html) instructions to setup the bot development environment. 79 | 80 | 2 - Clone the GitHub repository to run the sample. 81 | 82 | ``` 83 | git clone https://github.com/mattermost/mattermost-bot-sample-golang.git 84 | cd mattermost-bot-sample-golang 85 | ``` 86 | 87 | 3 - Log into your mattermost instance using these credentials and create a bot account following [these](https://developers.mattermost.com/integrate/reference/bot-accounts/) instructions. 88 | 89 | 4 - Copy `example.env` to `.env` and fill in the bot token (obtained from the previous step), team name, etc. Alternatively, just provide your credentials as environment variables. 90 | 91 | 5 - Run with 92 | 93 | ``` 94 | make run 95 | ``` 96 | 97 | You can verify the Bot is running when 98 | 99 | - `Logged in to mattermost` appears on the command line. 100 | - `Hi! I am a bot.` is posted in your specified channel. 101 | 102 | ## Test the Bot 103 | 104 | 1 - Log in to the Mattermost server as `bill@example.com` and `Password1!`. 105 | 106 | 2 - Join your specified channel. 107 | 108 | 3 - Post a message in the channel such as `hello?` to see if the Bot responds. You should see a response if the Bot is running. 109 | 110 | ## Stop the Bot 111 | 112 | 1 - In the terminal window, press `CTRL+C` to stop the bot. 113 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | "os" 7 | "os/signal" 8 | "regexp" 9 | "time" 10 | 11 | "github.com/mattermost/mattermost-server/v6/model" 12 | "github.com/rs/zerolog" 13 | ) 14 | 15 | func main() { 16 | 17 | app := &application{ 18 | logger: zerolog.New( 19 | zerolog.ConsoleWriter{ 20 | Out: os.Stdout, 21 | TimeFormat: time.RFC822, 22 | }, 23 | ).With().Timestamp().Logger(), 24 | } 25 | 26 | app.config = loadConfig() 27 | app.logger.Info().Str("config", fmt.Sprint(app.config)).Msg("") 28 | 29 | setupGracefulShutdown(app) 30 | 31 | // Create a new mattermost client. 32 | app.mattermostClient = model.NewAPIv4Client(app.config.mattermostServer.String()) 33 | 34 | // Login. 35 | app.mattermostClient.SetToken(app.config.mattermostToken) 36 | 37 | if user, resp, err := app.mattermostClient.GetUser("me", ""); err != nil { 38 | app.logger.Fatal().Err(err).Msg("Could not log in") 39 | } else { 40 | app.logger.Debug().Interface("user", user).Interface("resp", resp).Msg("") 41 | app.logger.Info().Msg("Logged in to mattermost") 42 | app.mattermostUser = user 43 | } 44 | 45 | // Find and save the bot's team to app struct. 46 | if team, resp, err := app.mattermostClient.GetTeamByName(app.config.mattermostTeamName, ""); err != nil { 47 | app.logger.Fatal().Err(err).Msg("Could not find team. Is this bot a member ?") 48 | } else { 49 | app.logger.Debug().Interface("team", team).Interface("resp", resp).Msg("") 50 | app.mattermostTeam = team 51 | } 52 | 53 | // Find and save the talking channel to app struct. 54 | if channel, resp, err := app.mattermostClient.GetChannelByName( 55 | app.config.mattermostChannel, app.mattermostTeam.Id, "", 56 | ); err != nil { 57 | app.logger.Fatal().Err(err).Msg("Could not find channel. Is this bot added to that channel ?") 58 | } else { 59 | app.logger.Debug().Interface("channel", channel).Interface("resp", resp).Msg("") 60 | app.mattermostChannel = channel 61 | } 62 | 63 | // Send a message (new post). 64 | sendMsgToTalkingChannel(app, "Hi! I am a bot.", "") 65 | 66 | // Listen to live events coming in via websocket. 67 | listenToEvents(app) 68 | } 69 | 70 | func setupGracefulShutdown(app *application) { 71 | c := make(chan os.Signal, 1) 72 | signal.Notify(c, os.Interrupt) 73 | go func() { 74 | for range c { 75 | if app.mattermostWebSocketClient != nil { 76 | app.logger.Info().Msg("Closing websocket connection") 77 | app.mattermostWebSocketClient.Close() 78 | } 79 | app.logger.Info().Msg("Shutting down") 80 | os.Exit(0) 81 | } 82 | }() 83 | } 84 | 85 | func sendMsgToTalkingChannel(app *application, msg string, replyToId string) { 86 | // Note that replyToId should be empty for a new post. 87 | // All replies in a thread should reply to root. 88 | 89 | post := &model.Post{} 90 | post.ChannelId = app.mattermostChannel.Id 91 | post.Message = msg 92 | 93 | post.RootId = replyToId 94 | 95 | if _, _, err := app.mattermostClient.CreatePost(post); err != nil { 96 | app.logger.Error().Err(err).Str("RootID", replyToId).Msg("Failed to create post") 97 | } 98 | } 99 | 100 | func listenToEvents(app *application) { 101 | var err error 102 | failCount := 0 103 | for { 104 | app.mattermostWebSocketClient, err = model.NewWebSocketClient4( 105 | fmt.Sprintf("ws://%s", app.config.mattermostServer.Host+app.config.mattermostServer.Path), 106 | app.mattermostClient.AuthToken, 107 | ) 108 | if err != nil { 109 | app.logger.Warn().Err(err).Msg("Mattermost websocket disconnected, retrying") 110 | failCount += 1 111 | // TODO: backoff based on failCount and sleep for a while. 112 | continue 113 | } 114 | app.logger.Info().Msg("Mattermost websocket connected") 115 | 116 | app.mattermostWebSocketClient.Listen() 117 | 118 | for event := range app.mattermostWebSocketClient.EventChannel { 119 | // Launch new goroutine for handling the actual event. 120 | // If required, you can limit the number of events beng processed at a time. 121 | go handleWebSocketEvent(app, event) 122 | } 123 | } 124 | } 125 | 126 | func handleWebSocketEvent(app *application, event *model.WebSocketEvent) { 127 | 128 | // Ignore other channels. 129 | if event.GetBroadcast().ChannelId != app.mattermostChannel.Id { 130 | return 131 | } 132 | 133 | // Ignore other types of events. 134 | if event.EventType() != model.WebsocketEventPosted { 135 | return 136 | } 137 | 138 | // Since this event is a post, unmarshal it to (*model.Post) 139 | post := &model.Post{} 140 | err := json.Unmarshal([]byte(event.GetData()["post"].(string)), &post) 141 | if err != nil { 142 | app.logger.Error().Err(err).Msg("Could not cast event to *model.Post") 143 | } 144 | 145 | // Ignore messages sent by this bot itself. 146 | if post.UserId == app.mattermostUser.Id { 147 | return 148 | } 149 | 150 | // Handle however you want. 151 | handlePost(app, post) 152 | } 153 | 154 | func handlePost(app *application, post *model.Post) { 155 | app.logger.Debug().Str("message", post.Message).Msg("") 156 | app.logger.Debug().Interface("post", post).Msg("") 157 | 158 | if matched, _ := regexp.MatchString(`(?:^|\W)hello(?:$|\W)`, post.Message); matched { 159 | 160 | // If post has a root ID then its part of thread, so reply there. 161 | // If not, then post is independent, so reply to the post. 162 | if post.RootId != "" { 163 | sendMsgToTalkingChannel(app, "I replied in an existing thread.", post.RootId) 164 | } else { 165 | sendMsgToTalkingChannel(app, "I just replied to a new post, starting a chain.", post.Id) 166 | } 167 | return 168 | } 169 | } 170 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Copyright 2016-2017 Mattermost, Inc. 2 | 3 | Apache License 4 | Version 2.0, January 2004 5 | http://www.apache.org/licenses/ 6 | 7 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 8 | 9 | 1. Definitions. 10 | 11 | "License" shall mean the terms and conditions for use, reproduction, 12 | and distribution as defined by Sections 1 through 9 of this document. 13 | 14 | "Licensor" shall mean the copyright owner or entity authorized by 15 | the copyright owner that is granting the License. 16 | 17 | "Legal Entity" shall mean the union of the acting entity and all 18 | other entities that control, are controlled by, or are under common 19 | control with that entity. For the purposes of this definition, 20 | "control" means (i) the power, direct or indirect, to cause the 21 | direction or management of such entity, whether by contract or 22 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 23 | outstanding shares, or (iii) beneficial ownership of such entity. 24 | 25 | "You" (or "Your") shall mean an individual or Legal Entity 26 | exercising permissions granted by this License. 27 | 28 | "Source" form shall mean the preferred form for making modifications, 29 | including but not limited to software source code, documentation 30 | source, and configuration files. 31 | 32 | "Object" form shall mean any form resulting from mechanical 33 | transformation or translation of a Source form, including but 34 | not limited to compiled object code, generated documentation, 35 | and conversions to other media types. 36 | 37 | "Work" shall mean the work of authorship, whether in Source or 38 | Object form, made available under the License, as indicated by a 39 | copyright notice that is included in or attached to the work 40 | (an example is provided in the Appendix below). 41 | 42 | "Derivative Works" shall mean any work, whether in Source or Object 43 | form, that is based on (or derived from) the Work and for which the 44 | editorial revisions, annotations, elaborations, or other modifications 45 | represent, as a whole, an original work of authorship. For the purposes 46 | of this License, Derivative Works shall not include works that remain 47 | separable from, or merely link (or bind by name) to the interfaces of, 48 | the Work and Derivative Works thereof. 49 | 50 | "Contribution" shall mean any work of authorship, including 51 | the original version of the Work and any modifications or additions 52 | to that Work or Derivative Works thereof, that is intentionally 53 | submitted to Licensor for inclusion in the Work by the copyright owner 54 | or by an individual or Legal Entity authorized to submit on behalf of 55 | the copyright owner. For the purposes of this definition, "submitted" 56 | means any form of electronic, verbal, or written communication sent 57 | to the Licensor or its representatives, including but not limited to 58 | communication on electronic mailing lists, source code control systems, 59 | and issue tracking systems that are managed by, or on behalf of, the 60 | Licensor for the purpose of discussing and improving the Work, but 61 | excluding communication that is conspicuously marked or otherwise 62 | designated in writing by the copyright owner as "Not a Contribution." 63 | 64 | "Contributor" shall mean Licensor and any individual or Legal Entity 65 | on behalf of whom a Contribution has been received by Licensor and 66 | subsequently incorporated within the Work. 67 | 68 | 2. Grant of Copyright License. Subject to the terms and conditions of 69 | this License, each Contributor hereby grants to You a perpetual, 70 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 71 | copyright license to reproduce, prepare Derivative Works of, 72 | publicly display, publicly perform, sublicense, and distribute the 73 | Work and such Derivative Works in Source or Object form. 74 | 75 | 3. Grant of Patent License. Subject to the terms and conditions of 76 | this License, each Contributor hereby grants to You a perpetual, 77 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 78 | (except as stated in this section) patent license to make, have made, 79 | use, offer to sell, sell, import, and otherwise transfer the Work, 80 | where such license applies only to those patent claims licensable 81 | by such Contributor that are necessarily infringed by their 82 | Contribution(s) alone or by combination of their Contribution(s) 83 | with the Work to which such Contribution(s) was submitted. If You 84 | institute patent litigation against any entity (including a 85 | cross-claim or counterclaim in a lawsuit) alleging that the Work 86 | or a Contribution incorporated within the Work constitutes direct 87 | or contributory patent infringement, then any patent licenses 88 | granted to You under this License for that Work shall terminate 89 | as of the date such litigation is filed. 90 | 91 | 4. Redistribution. You may reproduce and distribute copies of the 92 | Work or Derivative Works thereof in any medium, with or without 93 | modifications, and in Source or Object form, provided that You 94 | meet the following conditions: 95 | 96 | (a) You must give any other recipients of the Work or 97 | Derivative Works a copy of this License; and 98 | 99 | (b) You must cause any modified files to carry prominent notices 100 | stating that You changed the files; and 101 | 102 | (c) You must retain, in the Source form of any Derivative Works 103 | that You distribute, all copyright, patent, trademark, and 104 | attribution notices from the Source form of the Work, 105 | excluding those notices that do not pertain to any part of 106 | the Derivative Works; and 107 | 108 | (d) If the Work includes a "NOTICE" text file as part of its 109 | distribution, then any Derivative Works that You distribute must 110 | include a readable copy of the attribution notices contained 111 | within such NOTICE file, excluding those notices that do not 112 | pertain to any part of the Derivative Works, in at least one 113 | of the following places: within a NOTICE text file distributed 114 | as part of the Derivative Works; within the Source form or 115 | documentation, if provided along with the Derivative Works; or, 116 | within a display generated by the Derivative Works, if and 117 | wherever such third-party notices normally appear. The contents 118 | of the NOTICE file are for informational purposes only and 119 | do not modify the License. You may add Your own attribution 120 | notices within Derivative Works that You distribute, alongside 121 | or as an addendum to the NOTICE text from the Work, provided 122 | that such additional attribution notices cannot be construed 123 | as modifying the License. 124 | 125 | You may add Your own copyright statement to Your modifications and 126 | may provide additional or different license terms and conditions 127 | for use, reproduction, or distribution of Your modifications, or 128 | for any such Derivative Works as a whole, provided Your use, 129 | reproduction, and distribution of the Work otherwise complies with 130 | the conditions stated in this License. 131 | 132 | 5. Submission of Contributions. Unless You explicitly state otherwise, 133 | any Contribution intentionally submitted for inclusion in the Work 134 | by You to the Licensor shall be under the terms and conditions of 135 | this License, without any additional terms or conditions. 136 | Notwithstanding the above, nothing herein shall supersede or modify 137 | the terms of any separate license agreement you may have executed 138 | with Licensor regarding such Contributions. 139 | 140 | 6. Trademarks. This License does not grant permission to use the trade 141 | names, trademarks, service marks, or product names of the Licensor, 142 | except as required for reasonable and customary use in describing the 143 | origin of the Work and reproducing the content of the NOTICE file. 144 | 145 | 7. Disclaimer of Warranty. Unless required by applicable law or 146 | agreed to in writing, Licensor provides the Work (and each 147 | Contributor provides its Contributions) on an "AS IS" BASIS, 148 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 149 | implied, including, without limitation, any warranties or conditions 150 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 151 | PARTICULAR PURPOSE. You are solely responsible for determining the 152 | appropriateness of using or redistributing the Work and assume any 153 | risks associated with Your exercise of permissions under this License. 154 | 155 | 8. Limitation of Liability. In no event and under no legal theory, 156 | whether in tort (including negligence), contract, or otherwise, 157 | unless required by applicable law (such as deliberate and grossly 158 | negligent acts) or agreed to in writing, shall any Contributor be 159 | liable to You for damages, including any direct, indirect, special, 160 | incidental, or consequential damages of any character arising as a 161 | result of this License or out of the use or inability to use the 162 | Work (including but not limited to damages for loss of goodwill, 163 | work stoppage, computer failure or malfunction, or any and all 164 | other commercial damages or losses), even if such Contributor 165 | has been advised of the possibility of such damages. 166 | 167 | 9. Accepting Warranty or Additional Liability. While redistributing 168 | the Work or Derivative Works thereof, You may choose to offer, 169 | and charge a fee for, acceptance of support, warranty, indemnity, 170 | or other liability obligations and/or rights consistent with this 171 | License. However, in accepting such obligations, You may act only 172 | on Your own behalf and on Your sole responsibility, not on behalf 173 | of any other Contributor, and only if You agree to indemnify, 174 | defend, and hold each Contributor harmless for any liability 175 | incurred by, or claims asserted against, such Contributor by reason 176 | of your accepting any such warranty or additional liability. 177 | 178 | END OF TERMS AND CONDITIONS 179 | 180 | APPENDIX: How to apply the Apache License to your work. 181 | 182 | To apply the Apache License to your work, attach the following 183 | boilerplate notice, with the fields enclosed by brackets "{}" 184 | replaced with your own identifying information. (Don't include 185 | the brackets!) The text should be enclosed in the appropriate 186 | comment syntax for the file format. We also recommend that a 187 | file or class name and description of purpose be included on the 188 | same "printed page" as the copyright notice for easier 189 | identification within third-party archives. 190 | 191 | Copyright {yyyy} {name of copyright owner} 192 | 193 | Licensed under the Apache License, Version 2.0 (the "License"); 194 | you may not use this file except in compliance with the License. 195 | You may obtain a copy of the License at 196 | 197 | http://www.apache.org/licenses/LICENSE-2.0 198 | 199 | Unless required by applicable law or agreed to in writing, software 200 | distributed under the License is distributed on an "AS IS" BASIS, 201 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 202 | See the License for the specific language governing permissions and 203 | limitations under the License. 204 | --------------------------------------------------------------------------------