├── .gitignore ├── .circleci └── config.yml ├── project.clj ├── src ├── test │ └── clj │ │ └── humanize │ │ ├── schema_test.clj │ │ ├── user.clj │ │ └── schema_error_structure_test.clj └── main │ └── clj │ └── humanize │ └── schema.clj ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /classes 3 | /checkouts 4 | pom.xml 5 | pom.xml.asc 6 | *.jar 7 | *.class 8 | /.lein-* 9 | /.nrepl-port 10 | .hgignore 11 | .hg/ 12 | *.iml 13 | .idea/ 14 | doc/ 15 | -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | # Clojure CircleCI 2.0 configuration file 2 | # 3 | # Check https://circleci.com/docs/2.0/language-clojure/ for more details 4 | # 5 | version: 2 6 | jobs: 7 | build: 8 | docker: 9 | # specify the version you desire here 10 | - image: circleci/clojure:lein-2.7.1 11 | 12 | working_directory: ~/repo 13 | 14 | environment: 15 | LEIN_ROOT: "true" 16 | # Customize the JVM maximum heap limit 17 | JVM_OPTS: -Xmx1g 18 | 19 | steps: 20 | - checkout 21 | - restore_cache: 22 | keys: 23 | - v1-dependencies-{{ checksum "project.clj" }} 24 | # fallback to using the latest cache if no exact match is found 25 | - v1-dependencies- 26 | - run: lein deps 27 | - save_cache: 28 | paths: 29 | - ~/.m2 30 | key: v1-dependencies-{{ checksum "project.clj" }} 31 | - run: lein test 32 | 33 | -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject siili/humanize "0.1.2-SNAPSHOT" 2 | :description "Translate computer produced garble into human readable form" 3 | :url "https://github.com/siilisolutions/humanize" 4 | :license {:name "Eclipse Public License" 5 | :url "http://www.eclipse.org/legal/epl-v10.html"} 6 | :dependencies [[org.clojure/clojure "1.8.0"] 7 | [org.clojure/core.match "0.3.0-alpha5"] 8 | [prismatic/schema "1.1.7"]] 9 | :source-paths ["src/main/clj"] 10 | :test-paths ["src/test/clj"] 11 | :repl-options {:init-ns humanize.user} 12 | :plugins [[lein-cljfmt "0.5.7"] 13 | [lein-codox "0.10.3"] 14 | [lein-eftest "0.4.3"] 15 | [lein-kibit "0.1.5"]] 16 | :codox {:output-path "docs/api"} 17 | :global-vars {*warn-on-reflection* true} 18 | :profiles {:uberjar {:aot :all}} 19 | :deploy-repositories [["releases" {:url "https://clojars.org/repo" 20 | :username :env 21 | :password :env 22 | :sign-releases false}]] 23 | :release-tasks [["vcs" "assert-committed"] 24 | ["change" "version" "leiningen.release/bump-version" "release"] 25 | ["vcs" "commit"] 26 | ["vcs" "tag" "v" "--no-sign"] 27 | ["deploy"] 28 | ["change" "version" "leiningen.release/bump-version"] 29 | ["vcs" "commit"]]) 30 | -------------------------------------------------------------------------------- /src/test/clj/humanize/schema_test.clj: -------------------------------------------------------------------------------- 1 | (ns humanize.schema-test 2 | (:require [clojure.test :refer :all] 3 | [humanize.schema :as hs] 4 | [schema.core :as s] 5 | [schema.utils :refer [named-error-explain validation-error-explain]]) 6 | (:import [schema.utils NamedError ValidationError])) 7 | 8 | (s/defn one :- s/Int 9 | [a :- s/Int] 10 | a) 11 | 12 | (s/defn incompat-ret :- s/Str 13 | [a :- s/Int] 14 | a) 15 | 16 | (s/defn three :- s/Int 17 | [a :- s/Int 18 | b :- s/Int 19 | c :- s/Int] 20 | (+ a b c)) 21 | 22 | (defn inspect 23 | "Simply captures exceptions thrown by given function and returns the 24 | exception for further inspection." 25 | [f] 26 | (try 27 | (f) 28 | (throw (AssertionError. "The wrapped function did not throw an exception")) 29 | (catch clojure.lang.ExceptionInfo e 30 | e))) 31 | 32 | (deftest errors-test 33 | (testing "single param error can be humanized" 34 | (let [err (-> (inspect (partial one :s)) hs/ex->err)] 35 | (println err) 36 | (is (= "':s' is not an integer." 37 | (hs/humanize (-> err :in first second)))))) 38 | 39 | (testing "return type error can be humanized" 40 | (let [err (-> (inspect (partial incompat-ret 1)) hs/ex->err)] 41 | (println err) 42 | (is (= "'1' is not a string but it should be." 43 | (hs/humanize (-> err :out :error))))))) 44 | 45 | (deftest check-compatibility 46 | (testing "explain works as is with s/check" 47 | (is (= "'three' is not an integer." (hs/explain (s/check s/Int "three")))))) -------------------------------------------------------------------------------- /src/test/clj/humanize/user.clj: -------------------------------------------------------------------------------- 1 | (ns humanize.user 2 | (require [clojure.pprint :refer [pprint]] 3 | [schema.core :as s] 4 | [humanize.schema :as husch])) 5 | 6 | (s/set-fn-validation! true) 7 | 8 | (s/defschema map-schema {:int s/Int 9 | :str s/Str 10 | :bool s/Bool 11 | :vec [s/Int] 12 | :map {s/Any s/Any} 13 | :nested {:vec [{s/Str s/Int}] 14 | :map {s/Str s/Int} 15 | :deep {:a s/Int}}}) 16 | (def broken-map {:int "1" 17 | :str :string 18 | :vec "vector" 19 | :map {:foo :bar} 20 | :nested {:vec '(:a :b) 21 | :map {false true} 22 | :deep {:a "hello"}}}) 23 | 24 | (s/defn foo :- s/Any 25 | [m :- map-schema] 26 | (println m)) 27 | 28 | (s/defn bar :- s/Any 29 | [v :- s/Int] 30 | (println v)) 31 | 32 | (s/defn baz :- s/Any 33 | [a :- s/Int 34 | b :- s/Int] 35 | (println a b)) 36 | 37 | (s/defn bam :- s/Int 38 | [a :- s/Int 39 | b :- s/Int] 40 | (println a b)) 41 | 42 | (defn fail 43 | [f] 44 | (try (f) (catch clojure.lang.ExceptionInfo ei ei))) 45 | 46 | (defn fail-map 47 | [v] 48 | (fail (partial foo v))) 49 | 50 | (defn fail-val 51 | [v] 52 | (fail (partial bar v))) 53 | 54 | (defn fail-many 55 | [a b] 56 | (fail (partial baz a b))) 57 | 58 | (defn fail-all 59 | [a b] 60 | (fail (partial bam a b))) 61 | -------------------------------------------------------------------------------- /src/test/clj/humanize/schema_error_structure_test.clj: -------------------------------------------------------------------------------- 1 | (ns humanize.schema-error-structure-test 2 | (:require [clojure.test :refer :all] 3 | [humanize.schema :as hs] 4 | [schema.core :as s] 5 | [schema.utils :refer [named-error-explain validation-error-explain]]) 6 | (:import [schema.utils NamedError ValidationError])) 7 | 8 | ;; So turns out Schema jams _everything_ into a single vector in 9 | ;; ExceptionInfo's :error. These tests are here just to work as a spec of 10 | ;; sorts for myself. 11 | 12 | (s/defn one :- s/Int 13 | [a :- s/Int] 14 | a) 15 | 16 | (s/defn incompat-ret :- s/Str 17 | [a :- s/Int] 18 | a) 19 | 20 | (s/defn three :- s/Int 21 | [a :- s/Int 22 | b :- s/Int 23 | c :- s/Int] 24 | (+ a b c)) 25 | 26 | (defn capture 27 | [f] 28 | (try 29 | (f) 30 | (throw (AssertionError. "The wrapped function did not throw an exception")) 31 | (catch clojure.lang.ExceptionInfo e 32 | (ex-data e)))) 33 | 34 | (deftest errors-test 35 | (testing "wrong param type is 'NamedError' in vector" 36 | (let [err (-> (capture (partial one :s)) :error)] 37 | (is (vector? err)) 38 | (is (instance? NamedError (first err))))) 39 | (testing "wrong return type is 'ValidationError' as is" 40 | (let [err (-> (capture (partial incompat-ret 1)) :error)] 41 | (is (instance? ValidationError err)))) 42 | (testing "nil in param vector means given value is ok" 43 | (let [err (-> (capture (partial three 1 :2 3)) :error)] 44 | (is (nil? (get err 0))) 45 | (is (instance? NamedError (get err 1))) 46 | (is (nil? (get err 2)))))) 47 | -------------------------------------------------------------------------------- /src/main/clj/humanize/schema.clj: -------------------------------------------------------------------------------- 1 | (ns humanize.schema 2 | (:require [clojure.walk :refer [postwalk]] 3 | [clojure.core.match :refer [match]] 4 | [schema.utils :refer [validation-error-explain]] 5 | [schema.core :as s]) 6 | (:import (schema.utils NamedError ValidationError))) 7 | 8 | ;; Originally based on and then heavily refactored from 9 | ;; https://gist.github.com/rauhs/cfdb55a8314e0d3f4862 10 | 11 | (defn- vectorize 12 | "Recursively transforms all seq in m to vectors. 13 | Because maybe you want to use core.match with it." 14 | [x] 15 | (postwalk #(if (seq? %) (vec %) %) 16 | x)) 17 | 18 | (defn humanize 19 | "Returns a human explanation of a SINGLE error. 20 | This is for errors which are from USER input. It is not for programming errors. 21 | If the error is a map/vector then this function must be applied to each of those 22 | values." 23 | ([x] (humanize x identity)) 24 | ([x additional-translations] 25 | ;; http://stackoverflow.com/questions/25189031/clojure-core-match-cant-match-on-class 26 | ;; TLDR: We can't match on classes (it'd be bound to that symbol) 27 | ;; However, match will first try to match a local binding if it exists: 28 | (let [String java.lang.String 29 | Number java.lang.Number 30 | Boolean java.lang.Boolean] 31 | (match 32 | x 33 | ;; Schema built-in structures: 34 | ['not ['pos? num]] 35 | (str num " is not positive but it should be.") 36 | 37 | ['not ['instance? Number not-num]] 38 | (str "'" not-num "' is not a number but it should be.") 39 | 40 | ['not ['instance? String not-num]] 41 | (str "'" not-num "' is not a string but it should be.") 42 | 43 | ['not ['instance? Boolean not-bool]] 44 | (str "'" not-bool "' is not a boolean but it should be.") 45 | 46 | ;; We can use core.match's :guard to apply a function check: 47 | ;; error by s/enum: (not (#{:x :y} :foo)) 48 | ['not [(enum :guard set?) given]] 49 | (str "The value must be one of " enum " but was '" given "' instead.") 50 | 51 | ['not ['map? val]] 52 | (str "The value must be a map, but was '" val "' instead.") 53 | 54 | ['not ['integer? non-int]] 55 | (str "'" non-int "' is not an integer.") 56 | 57 | ['not ['sequential? non-seq]] 58 | (str "Value is expected to be sequential, but was '" non-seq "' instead.") 59 | 60 | ;; Recurse into Schema's nested NamedError: 61 | ['named inner name] 62 | (humanize inner) 63 | 64 | ;; Error was not generic enough to resolve on this level: 65 | :else 66 | (additional-translations x))))) 67 | 68 | (defn explain 69 | ([x] (explain x identity)) 70 | ([x additional-translations] 71 | (cond 72 | (map? x) 73 | (into 74 | (sorted-map) 75 | (map 76 | (fn [[k v]] 77 | [(explain k additional-translations) ;; the key itself might be a validation error 78 | (explain v additional-translations)]) ;; value might actually indicate issues with the key 79 | x)) 80 | 81 | (or (seq? x) 82 | (coll? x)) 83 | (mapv #(explain % additional-translations) x) 84 | 85 | (instance? ValidationError x) 86 | (humanize (vectorize (validation-error-explain x)) additional-translations) 87 | 88 | ;; these are Schema's built-in symbols which are kind of hard to match 89 | ;; in uniform fashion so it's easier to just do the replacement here 90 | (symbol? x) 91 | (cond 92 | (= 'missing-required-key x) 93 | "Missing required key" 94 | 95 | (= 'invalid-key) 96 | "Invalid key.") 97 | 98 | :else 99 | x))) 100 | 101 | (defn- explain-single 102 | "Explains single NamedError. In case the value is nil (indicates no error) 103 | the key :ok is instead returned in its place." 104 | [ne additional-translations] 105 | (if-not (nil? ne) 106 | (explain (.error ^NamedError ne) additional-translations) 107 | :ok)) 108 | 109 | (defn- extract-param-errors 110 | "Zips param names with their matching error explanations." 111 | [err additional-translations] 112 | (map 113 | vector 114 | (map #(.name %) (:schema err)) 115 | (map #(explain-single % additional-translations) (:error err)))) 116 | 117 | (defn- walk 118 | [err additional-translations] 119 | (cond 120 | (vector? (:error err)) {:in (extract-param-errors err additional-translations)} 121 | (instance? ValidationError (:error err)) {:out (explain err additional-translations)} 122 | :else {:unknown err})) 123 | 124 | (defn ex->err 125 | "Convert Schema exception into descriptive data structure showing errors. 126 | Returns nil if errors could not be extracted." 127 | ([ex] (ex->err ex identity)) 128 | ([ex user-provided-translations] 129 | (some-> ex ex-data (walk user-provided-translations)))) 130 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 🤖 `(humanize ex)` 😊 2 | 3 | Library for translating errors into human readable form. 4 | 5 | [![License](https://img.shields.io/badge/License-EPL%201.0-red.svg)](https://opensource.org/licenses/EPL-1.0) [![CircleCI](https://img.shields.io/circleci/project/github/siilisolutions/humanize.svg)](https://circleci.com/gh/siilisolutions/humanize) [![cljdoc badge](https://cljdoc.xyz/badge/siili/humanize)](https://cljdoc.xyz/d/siili/humanize/CURRENT) 6 | 7 | ## Installation 8 | 9 | Add `siili/humanize` to your project: 10 | [![Clojars Project](https://img.shields.io/clojars/v/siili/humanize.svg)](https://clojars.org/siili/humanize) 11 | 12 | > Not sure if humanize is for you? We recommend testing it with [`lein try`](https://github.com/rkneufeld/lein-try)! 13 | 14 | ## Usage 15 | 16 | Base usage is very simple: 17 | 1. Require namespace you need 18 | 1. Use `ex->err` function from humanize's namespace to convert exceptions into translated error data 19 | 1. Use that data in any way you please 20 | 21 | ### Translated error data format 22 | 23 | - The main data structure is always a map 24 | - There are three keywords which describe where the error(s) occurred: 25 | - `:in` input to function is faulty 26 | - `:out` function's output is faulty 27 | - `:unknown` faulty data occurred in unspecified location 28 | - `:in` is a vector where each entry describes one argument to function in the same order as they are defined in function signature 29 | - `:out` is a single value 30 | - `:unknown` is unspecified 31 | 32 | ### Example: with [Plumatic Schema](https://github.com/plumatic/schema) 33 | 34 | ```clojure 35 | ;; require needed namespaces 36 | (require '[schema.core :as s] 37 | '[humanize.schema :as h]) 38 | 39 | ;; humanize is meant for interop with s/defn functions 40 | (s/defn broken :- s/Str 41 | [x :- s/Int] 42 | x) 43 | 44 | ;; boilerplate for calling the broken function in invalid way 45 | (defn check [f] 46 | (try 47 | (f) 48 | (catch clojure.lang.ExceptionInfo e 49 | (if (= (-> e ex-data :type) 50 | :schema.core/error) 51 | (h/ex->err e))))) 52 | 53 | (check #(broken "two")) 54 | 55 | => {:in ([x "'two' is not an integer."])} 56 | ``` 57 | 58 | ## Extending 59 | 60 | Humanize can only handle the built-in types and structures. For user defined types an additional translator function can be provided to utilize humanize's internal resolver logic. 61 | 62 | For example, assuming the following regular expression checking variant schema has been defined by user: 63 | ```clojure 64 | (ns my.ns 65 | (:require [schema.core :as s] 66 | [schema.spec.variant :as variant] 67 | [schema.spec.core :as spec])) 68 | 69 | (defrecord RegexString [regex] 70 | s/Schema 71 | (spec [this] 72 | (variant/variant-spec 73 | spec/+no-precondition+ 74 | [{:schema s/Str}] 75 | nil 76 | ;; take special note of this line, the list at the end is important 77 | (spec/precondition this (partial re-matches regex) #(list 'not-matching regex %)))) 78 | (explain [this] 79 | (list 'regex-constrained (s/explain s/Str) regex))) 80 | ``` 81 | 82 | which is then used to define a custom validator: 83 | ```clojure 84 | (def AtoZ (RegexString. #"[AZ]+")) 85 | 86 | (s/defn yelling-alphas :- s/Any 87 | [aagh :- AtoZ] 88 | aagh) 89 | ``` 90 | running this through humanize in same manner as above would produce unresolved translation: 91 | ```clojure 92 | (check #(yelling-alphas "123")) 93 | 94 | => {:in ([aagh [not [not-matching #"[AZ]+" "123"]]])} 95 | ``` 96 | which isn't that useful. To resolve this, simply provide a additional translations function to `ex->err`: 97 | ```clojure 98 | (defn check [f additional-translations] 99 | (try 100 | (f) 101 | (catch clojure.lang.ExceptionInfo e 102 | (if (= (-> e ex-data :type) 103 | :schema.core/error) 104 | (h/ex->err e additional-translations))))) 105 | ``` 106 | and call it with your own logic (we recommend [clojure/core.match](https://github.com/clojure/core.match)) to get the desired result: 107 | 108 | ```clojure 109 | (defn my-translate [x] 110 | (clojure.core.match/match 111 | x 112 | ;; this matches with the spec/precondition list in variant spec 113 | ['not ['not-matching regex-pattern value]] 114 | (str value " does not match regex pattern " regex-pattern) 115 | 116 | :else 117 | x)) 118 | 119 | (check #(yelling-alphas "123") my-translate) 120 | => {:in ([aagh "123 does not match regex pattern [AZ]+"])} 121 | ``` 122 | 123 | ## Acknowledgements 124 | 125 | [André Rauh](https://gist.github.com/rauhs/cfdb55a8314e0d3f4862) for the original Plumatic Schema exception unroller. 126 | 127 | ## Related Work 128 | 129 | - For [`spec.alpha`](https://github.com/clojure/spec.alpha) see [bhb/expound](https://github.com/bhb/expound) 130 | - For older versions of Schema and additionally Avro, datomic, etc. see [cddr/integrity](https://github.com/cddr/integrity)
131 | It is possible some of the features of this library will find their way to humanize eventually 132 | 133 | ## License 134 | 135 | Copyright © 2018 Siili Solutions 136 | 137 | Distributed under the Eclipse Public License either version 1.0 or (at 138 | your option) any later version. 139 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC 2 | LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM 3 | CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 4 | 5 | 1. DEFINITIONS 6 | 7 | "Contribution" means: 8 | 9 | a) in the case of the initial Contributor, the initial code and 10 | documentation distributed under this Agreement, and 11 | 12 | b) in the case of each subsequent Contributor: 13 | 14 | i) changes to the Program, and 15 | 16 | ii) additions to the Program; 17 | 18 | where such changes and/or additions to the Program originate from and are 19 | distributed by that particular Contributor. A Contribution 'originates' from 20 | a Contributor if it was added to the Program by such Contributor itself or 21 | anyone acting on such Contributor's behalf. Contributions do not include 22 | additions to the Program which: (i) are separate modules of software 23 | distributed in conjunction with the Program under their own license 24 | agreement, and (ii) are not derivative works of the Program. 25 | 26 | "Contributor" means any person or entity that distributes the Program. 27 | 28 | "Licensed Patents" mean patent claims licensable by a Contributor which are 29 | necessarily infringed by the use or sale of its Contribution alone or when 30 | combined with the Program. 31 | 32 | "Program" means the Contributions distributed in accordance with this 33 | Agreement. 34 | 35 | "Recipient" means anyone who receives the Program under this Agreement, 36 | including all Contributors. 37 | 38 | 2. GRANT OF RIGHTS 39 | 40 | a) Subject to the terms of this Agreement, each Contributor hereby grants 41 | Recipient a non-exclusive, worldwide, royalty-free copyright license to 42 | reproduce, prepare derivative works of, publicly display, publicly perform, 43 | distribute and sublicense the Contribution of such Contributor, if any, and 44 | such derivative works, in source code and object code form. 45 | 46 | b) Subject to the terms of this Agreement, each Contributor hereby grants 47 | Recipient a non-exclusive, worldwide, royalty-free patent license under 48 | Licensed Patents to make, use, sell, offer to sell, import and otherwise 49 | transfer the Contribution of such Contributor, if any, in source code and 50 | object code form. This patent license shall apply to the combination of the 51 | Contribution and the Program if, at the time the Contribution is added by the 52 | Contributor, such addition of the Contribution causes such combination to be 53 | covered by the Licensed Patents. The patent license shall not apply to any 54 | other combinations which include the Contribution. No hardware per se is 55 | licensed hereunder. 56 | 57 | c) Recipient understands that although each Contributor grants the licenses 58 | to its Contributions set forth herein, no assurances are provided by any 59 | Contributor that the Program does not infringe the patent or other 60 | intellectual property rights of any other entity. Each Contributor disclaims 61 | any liability to Recipient for claims brought by any other entity based on 62 | infringement of intellectual property rights or otherwise. As a condition to 63 | exercising the rights and licenses granted hereunder, each Recipient hereby 64 | assumes sole responsibility to secure any other intellectual property rights 65 | needed, if any. For example, if a third party patent license is required to 66 | allow Recipient to distribute the Program, it is Recipient's responsibility 67 | to acquire that license before distributing the Program. 68 | 69 | d) Each Contributor represents that to its knowledge it has sufficient 70 | copyright rights in its Contribution, if any, to grant the copyright license 71 | set forth in this Agreement. 72 | 73 | 3. REQUIREMENTS 74 | 75 | A Contributor may choose to distribute the Program in object code form under 76 | its own license agreement, provided that: 77 | 78 | a) it complies with the terms and conditions of this Agreement; and 79 | 80 | b) its license agreement: 81 | 82 | i) effectively disclaims on behalf of all Contributors all warranties and 83 | conditions, express and implied, including warranties or conditions of title 84 | and non-infringement, and implied warranties or conditions of merchantability 85 | and fitness for a particular purpose; 86 | 87 | ii) effectively excludes on behalf of all Contributors all liability for 88 | damages, including direct, indirect, special, incidental and consequential 89 | damages, such as lost profits; 90 | 91 | iii) states that any provisions which differ from this Agreement are offered 92 | by that Contributor alone and not by any other party; and 93 | 94 | iv) states that source code for the Program is available from such 95 | Contributor, and informs licensees how to obtain it in a reasonable manner on 96 | or through a medium customarily used for software exchange. 97 | 98 | When the Program is made available in source code form: 99 | 100 | a) it must be made available under this Agreement; and 101 | 102 | b) a copy of this Agreement must be included with each copy of the Program. 103 | 104 | Contributors may not remove or alter any copyright notices contained within 105 | the Program. 106 | 107 | Each Contributor must identify itself as the originator of its Contribution, 108 | if any, in a manner that reasonably allows subsequent Recipients to identify 109 | the originator of the Contribution. 110 | 111 | 4. COMMERCIAL DISTRIBUTION 112 | 113 | Commercial distributors of software may accept certain responsibilities with 114 | respect to end users, business partners and the like. While this license is 115 | intended to facilitate the commercial use of the Program, the Contributor who 116 | includes the Program in a commercial product offering should do so in a 117 | manner which does not create potential liability for other Contributors. 118 | Therefore, if a Contributor includes the Program in a commercial product 119 | offering, such Contributor ("Commercial Contributor") hereby agrees to defend 120 | and indemnify every other Contributor ("Indemnified Contributor") against any 121 | losses, damages and costs (collectively "Losses") arising from claims, 122 | lawsuits and other legal actions brought by a third party against the 123 | Indemnified Contributor to the extent caused by the acts or omissions of such 124 | Commercial Contributor in connection with its distribution of the Program in 125 | a commercial product offering. The obligations in this section do not apply 126 | to any claims or Losses relating to any actual or alleged intellectual 127 | property infringement. In order to qualify, an Indemnified Contributor must: 128 | a) promptly notify the Commercial Contributor in writing of such claim, and 129 | b) allow the Commercial Contributor to control, and cooperate with the 130 | Commercial Contributor in, the defense and any related settlement 131 | negotiations. The Indemnified Contributor may participate in any such claim 132 | at its own expense. 133 | 134 | For example, a Contributor might include the Program in a commercial product 135 | offering, Product X. That Contributor is then a Commercial Contributor. If 136 | that Commercial Contributor then makes performance claims, or offers 137 | warranties related to Product X, those performance claims and warranties are 138 | such Commercial Contributor's responsibility alone. Under this section, the 139 | Commercial Contributor would have to defend claims against the other 140 | Contributors related to those performance claims and warranties, and if a 141 | court requires any other Contributor to pay any damages as a result, the 142 | Commercial Contributor must pay those damages. 143 | 144 | 5. NO WARRANTY 145 | 146 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON 147 | AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER 148 | EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR 149 | CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A 150 | PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the 151 | appropriateness of using and distributing the Program and assumes all risks 152 | associated with its exercise of rights under this Agreement , including but 153 | not limited to the risks and costs of program errors, compliance with 154 | applicable laws, damage to or loss of data, programs or equipment, and 155 | unavailability or interruption of operations. 156 | 157 | 6. DISCLAIMER OF LIABILITY 158 | 159 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY 160 | CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, 161 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION 162 | LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 163 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 164 | ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE 165 | EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY 166 | OF SUCH DAMAGES. 167 | 168 | 7. GENERAL 169 | 170 | If any provision of this Agreement is invalid or unenforceable under 171 | applicable law, it shall not affect the validity or enforceability of the 172 | remainder of the terms of this Agreement, and without further action by the 173 | parties hereto, such provision shall be reformed to the minimum extent 174 | necessary to make such provision valid and enforceable. 175 | 176 | If Recipient institutes patent litigation against any entity (including a 177 | cross-claim or counterclaim in a lawsuit) alleging that the Program itself 178 | (excluding combinations of the Program with other software or hardware) 179 | infringes such Recipient's patent(s), then such Recipient's rights granted 180 | under Section 2(b) shall terminate as of the date such litigation is filed. 181 | 182 | All Recipient's rights under this Agreement shall terminate if it fails to 183 | comply with any of the material terms or conditions of this Agreement and 184 | does not cure such failure in a reasonable period of time after becoming 185 | aware of such noncompliance. If all Recipient's rights under this Agreement 186 | terminate, Recipient agrees to cease use and distribution of the Program as 187 | soon as reasonably practicable. However, Recipient's obligations under this 188 | Agreement and any licenses granted by Recipient relating to the Program shall 189 | continue and survive. 190 | 191 | Everyone is permitted to copy and distribute copies of this Agreement, but in 192 | order to avoid inconsistency the Agreement is copyrighted and may only be 193 | modified in the following manner. The Agreement Steward reserves the right to 194 | publish new versions (including revisions) of this Agreement from time to 195 | time. No one other than the Agreement Steward has the right to modify this 196 | Agreement. The Eclipse Foundation is the initial Agreement Steward. The 197 | Eclipse Foundation may assign the responsibility to serve as the Agreement 198 | Steward to a suitable separate entity. Each new version of the Agreement will 199 | be given a distinguishing version number. The Program (including 200 | Contributions) may always be distributed subject to the version of the 201 | Agreement under which it was received. In addition, after a new version of 202 | the Agreement is published, Contributor may elect to distribute the Program 203 | (including its Contributions) under the new version. Except as expressly 204 | stated in Sections 2(a) and 2(b) above, Recipient receives no rights or 205 | licenses to the intellectual property of any Contributor under this 206 | Agreement, whether expressly, by implication, estoppel or otherwise. All 207 | rights in the Program not expressly granted under this Agreement are 208 | reserved. 209 | 210 | This Agreement is governed by the laws of the State of New York and the 211 | intellectual property laws of the United States of America. No party to this 212 | Agreement will bring a legal action under this Agreement more than one year 213 | after the cause of action arose. Each party waives its rights to a jury trial 214 | in any resulting litigation. 215 | --------------------------------------------------------------------------------