ruby-activeldap 0.7.4 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (74) hide show
  1. data/CHANGES +375 -0
  2. data/COPYING +340 -0
  3. data/LICENSE +58 -0
  4. data/Manifest.txt +33 -0
  5. data/README +63 -0
  6. data/Rakefile +37 -0
  7. data/TODO +31 -0
  8. data/benchmark/bench-al.rb +152 -0
  9. data/lib/{activeldap.rb → active_ldap.rb} +280 -263
  10. data/lib/active_ldap/adaptor/base.rb +29 -0
  11. data/lib/active_ldap/adaptor/ldap.rb +466 -0
  12. data/lib/active_ldap/association/belongs_to.rb +38 -0
  13. data/lib/active_ldap/association/belongs_to_many.rb +40 -0
  14. data/lib/active_ldap/association/collection.rb +80 -0
  15. data/lib/active_ldap/association/has_many.rb +48 -0
  16. data/lib/active_ldap/association/has_many_wrap.rb +56 -0
  17. data/lib/active_ldap/association/proxy.rb +89 -0
  18. data/lib/active_ldap/associations.rb +162 -0
  19. data/lib/active_ldap/attributes.rb +199 -0
  20. data/lib/active_ldap/base.rb +1343 -0
  21. data/lib/active_ldap/callbacks.rb +19 -0
  22. data/lib/active_ldap/command.rb +46 -0
  23. data/lib/active_ldap/configuration.rb +96 -0
  24. data/lib/active_ldap/connection.rb +137 -0
  25. data/lib/{activeldap → active_ldap}/ldap.rb +1 -1
  26. data/lib/active_ldap/object_class.rb +70 -0
  27. data/lib/active_ldap/schema.rb +258 -0
  28. data/lib/{activeldap → active_ldap}/timeout.rb +0 -0
  29. data/lib/{activeldap → active_ldap}/timeout_stub.rb +0 -0
  30. data/lib/active_ldap/user_password.rb +92 -0
  31. data/lib/active_ldap/validations.rb +78 -0
  32. data/rails/plugin/active_ldap/README +54 -0
  33. data/rails/plugin/active_ldap/init.rb +6 -0
  34. data/test/TODO +2 -0
  35. data/test/al-test-utils.rb +337 -0
  36. data/test/command.rb +62 -0
  37. data/test/config.yaml +8 -0
  38. data/test/config.yaml.sample +6 -0
  39. data/test/run-test.rb +17 -0
  40. data/test/test-unit-ext.rb +2 -0
  41. data/test/test_associations.rb +334 -0
  42. data/test/test_attributes.rb +71 -0
  43. data/test/test_base.rb +345 -0
  44. data/test/test_base_per_instance.rb +32 -0
  45. data/test/test_bind.rb +53 -0
  46. data/test/test_callback.rb +35 -0
  47. data/test/test_connection.rb +38 -0
  48. data/test/test_connection_per_class.rb +50 -0
  49. data/test/test_find.rb +36 -0
  50. data/test/test_groupadd.rb +50 -0
  51. data/test/test_groupdel.rb +46 -0
  52. data/test/test_groupls.rb +107 -0
  53. data/test/test_groupmod.rb +51 -0
  54. data/test/test_lpasswd.rb +75 -0
  55. data/test/test_object_class.rb +32 -0
  56. data/test/test_reflection.rb +173 -0
  57. data/test/test_schema.rb +166 -0
  58. data/test/test_user.rb +209 -0
  59. data/test/test_user_password.rb +93 -0
  60. data/test/test_useradd-binary.rb +59 -0
  61. data/test/test_useradd.rb +55 -0
  62. data/test/test_userdel.rb +48 -0
  63. data/test/test_userls.rb +86 -0
  64. data/test/test_usermod-binary-add-time.rb +62 -0
  65. data/test/test_usermod-binary-add.rb +61 -0
  66. data/test/test_usermod-binary-del.rb +64 -0
  67. data/test/test_usermod-lang-add.rb +57 -0
  68. data/test/test_usermod.rb +56 -0
  69. data/test/test_validation.rb +38 -0
  70. metadata +94 -21
  71. data/lib/activeldap/associations.rb +0 -170
  72. data/lib/activeldap/base.rb +0 -1456
  73. data/lib/activeldap/configuration.rb +0 -59
  74. data/lib/activeldap/schema2.rb +0 -217
data/CHANGES ADDED
@@ -0,0 +1,375 @@
1
+ 0.8.0:
2
+ * Makefile/gemspec system replaced with Rakefile + Hoe
3
+ * Bugfix: Allow base to be empty
4
+ * Add support for Date, DateTime, and Time objects (patch from Patrick Cole)
5
+ * Add support for a :filter argument to override the default attr=val LDAP search filter in find_all() and find() (patch from Patrick Cole)
6
+ * Add Base#update_attributes(hash) method which does bulk updates to attributes (patch from Patrick Cole) and saves immediately
7
+ * API CHANGE: #attributes now returns a Hash of attribute_name => clone(attribute_val)
8
+ * API CHANGE: #attribute_names now returns an alphabetically sorted list of attribute names
9
+ * API CHANGE;
10
+ * Added attributes=() as the implementation for update_attributes(hash) (without autosave)
11
+ * API TRANSITION: Base#write is now deprecated. Please use Base#save
12
+ * API TRANSITION: Added SaveError exception (which is a subclass of WriteError for now)
13
+ * API TRANSITION: Base.connect() is now deprecated. Please use Base.establish_connection()
14
+ * Added update_attribute(name, value) to update one attribute and save immediately
15
+ * #delete -> #destroy
16
+ * Base.destroy_all
17
+ * Base.delete(id) & Base.delete_all(filter)
18
+ * add Base.exists?(dnattr_val)
19
+ * attr_protected
20
+ * Base.update(dnattr_val, attributes_hash) - instantiate, update, save, return
21
+ * Base.update_all(updates_hash, filter)
22
+ * attribute_present?(attribute) - if not empty/nil
23
+ * has_attribute?(attr_name) - if in hash
24
+ * reload() (refetch from LDAP)
25
+ * make save() return false on fail
26
+ * make save!() raise EntryNotSaved exception
27
+ * to_xml()
28
+ * clear_active_connections!() -- Conn per class
29
+ - make @@active_connections and name them by
30
+ * base_class() (just return the ancestor)
31
+ * Separate ObjectClass changes to live in ActiveLDAP::ObjectClass
32
+ - add_objectclass
33
+ - remove_objectclass
34
+ - replace_objectclass
35
+ - disallow direct objectclass access?
36
+ # - e.g. Person.reset_column_information
37
+ # - this would mean cleaner loading I think
38
+ * support ActiveRecord::Validations.
39
+ * support ActiveRecord::Callbacks.
40
+ * rename to ActiveLdap from ActiveLDAP to integrate RoR easily and enforce
41
+ many API changes.
42
+
43
+ 0.7.4:
44
+ * Bugfix: do not base LDAP::PrettyError on RuntimeError due to rescue evaluation.
45
+ * Bugfix: :return_objects was overriding :objects in find and find_all
46
+ * Rollup exception code into smaller space reusing similar code.
47
+
48
+ 0.7.3:
49
+ * Made has_many and belongs_to use :return_objects value
50
+ * Force generation of LDAP constants on import - currently broken
51
+
52
+ 0.7.2:
53
+ * Stopped overriding Conn.schema in ldap/schema - now use schema2
54
+ * Fix attributes being deleted when changing between objectclasses with shared attributes
55
+ * Added schema attribute case insensitivity
56
+ * Added case insensitivity to the attribute methods.
57
+ * Added LDAP scope override support to ldap_mapping via :scope argument. (ldap_mapping :scope => LDAP::LDAP_SCOPE_SUBTREE, ...)
58
+ * Fixed the bug where Klass.find() return nil (default arg for find/find_all now '*')
59
+ * Added :return_objects to Base.connect()/configuration.rb -- When true, sets the default behavior in Base.find/find_all to return objects instead of just the dnattr string.
60
+ * Hid away several exposed private class methods (do_bind, etc)
61
+ * Undefined dnattr for a class now raises a ConfigurationError
62
+ * Centralized all connection management code where possible
63
+ * Added Base.can_reconnect? which returns true if never connected or below the :retries limit
64
+ * Added block support to Base.connection to ensure "safe" connection usage. This is not just for internal library use. If you need to do something fancy with the connection object, use Base.connection do |conn| ...
65
+ * Fixed object instantiation in Base#initialize when using full DNs
66
+ * Added :parent_class option to ldap_mapping which allows for object.parent() to return an instantiated object using the parent DN. (ldap_mapping :parent_class => String, ...)
67
+ * Fixed reconnect bug in Base#initialize (didn't respect infinite retries)
68
+ * Added(*) :timeout argument to allow timeouts on hanging LDAP connections
69
+ * Added(*) :retry_on_timeout boolean option to allow disabling retries on timeouts
70
+ * Added TimeoutError
71
+ * Added(*) a forking timeout using SIGALRM to interrupt handling.
72
+ * (*) Only works when RUBY_PLATFORM has "linux" in it
73
+
74
+ 0.7.1:
75
+ * Fix broken -W0 arg in activeldap.rb
76
+ * attribute_method=: '' and nil converted to ldap-pleasing [] values
77
+ * Added checks in write and search for connection down (to reconnect)
78
+ * Fixed broken idea of LDAP::err2string exceptions. Instead took errcodes from ldap.c in Ruby/LDAP.
79
+
80
+ 0.7.0:
81
+ * ConnectionError thrown from #initialize when there is no connection and retry limit was exceeded
82
+ * ConnectionError thrown when retries exceeded when no connection was created
83
+ * Separated connection types: SSL, TLS, and plain using :method
84
+ * Localized reconnect logic into Base.reconnect(force=false)
85
+ * Fixed password_block evaluation bug in do_bind() which broke SIMPLE re-binds and broke reconnect
86
+ * Add support for config[:sasl_quiet] in Base.connect
87
+ * (Delayed a case sensitivity patch for object classes and attributes due to weird errors)
88
+ * Add :retry_wait to Base.connect to determine the timeout before retrying a connection
89
+ * Fixed ActiveLDAP::Base.create_object() - classes were enclosed in quotes
90
+ * Added :ldap_scope Base.connect() argument to allow risk-seeking users to change the LDAP scope to something other than ONELEVEL.
91
+ * Cleaned up Configuration.rb to supply all default values for ActiveLDAP::Base.connect() and to use a constant instead of overriding class variables for no good reason.
92
+ * Added scrubbing for :base argument into Base.connect() to make sure a ' doesn't get evaluated.
93
+ * Refactored Base.connect(). It is now much cleaner and easier to follow.
94
+ * Moved schema retrieval to after bind in case a server requires privileges to access it.
95
+ * Reworked the bind process to be a little prettier. A lot of work to do here still.
96
+ * Added LDAP::err2exception(errno) which is the groundwork of a coming overhaul in user friendly error handling.
97
+ * Added support for Base::connect(.., :password => String, ...) to avoid stupid Proc.new {'foo'} crap
98
+ * Add :store_password option. When this is set, :password is not cleared and :password_block is not re-evaluated on each rebind.
99
+
100
+ 0.6.0:
101
+ * Disallow blank DN attribute values on initialization
102
+ * Fix bug reported by Maik Schmidt regarding object creation
103
+ * Added error checking to disallow DN attribute value changes
104
+ * Added AttributeAssignmentError (for above)
105
+ * Import() and initialize() no longer call attribute_method=()
106
+ * Added error condition if connection fails inside initialize()
107
+ * Changes examples and tests to use "dc=localdomain"
108
+ * has_many() entries no longer return nil when empty
109
+
110
+ 0.5.9:
111
+ * Change default base to dc=localdomain (as per Debian default).
112
+ * schema2.rb:attr() now returns [] instead of '' when empty.
113
+ * Lookup of new objects does not put dnattr()=value into the Base on lookup.
114
+ * Scope is now use ONELEVEL instead of SUBTREE as it broke object boundaries.
115
+ * Fixed @max_retries misuse.
116
+ * Added do_connect retries.
117
+ * Fixed find and find_all for the case - find_all('*').
118
+ * Fixed broken creation of objects from anonymous classes.
119
+ * Fixed broken use of ldap_mapping with anonymous classes.
120
+
121
+ 0.5.8: Bugfix galore
122
+ * Allow nil "prefix"
123
+ * Fixed the dup bug with Anonymous patch.
124
+ * (maybe) Fixed stale connection problems by attempting reconn/bind.
125
+ * Hiding redefine warnings (for now)
126
+
127
+ 0.5.7:
128
+ * Fixed the @data.default = [] bug that daniel@nightrunner.com pointed out
129
+ (and partially patched).
130
+
131
+ 0.5.6:
132
+ * Added support for foreign_key => 'dn' in has_many.
133
+
134
+ 0.5.5:
135
+ * Remove @@logger.debug entries during build
136
+ * Building -debug and regular gems and tarballs
137
+
138
+ 0.5.4:
139
+ * Added Base#import to streamline the Base.find and Base.find_all methods
140
+ - Speeds up find and find_all by not accessing LDAP multiple times
141
+ for data we already have.
142
+ * Added tests/benchmark which is a slightly modified version of excellent
143
+ benchmarking code contributed by
144
+ Ollivier Robert <roberto -_-AT-_- keltia.freenix.fr>.
145
+
146
+ 0.5.3:
147
+ * Changed attribute_method to send in associations
148
+ - fixes belongs_to (with local_kay) and inheritance around that
149
+
150
+ 0.5.2:
151
+ * Make sure values are .dup'd when they come from LDAP
152
+
153
+ 0.5.1:
154
+ * Changed Schema2#class_attributes to return {:must => [], :may => []}
155
+ * Fixed Base#must and Base#may to return with full SUPerclass requirements
156
+
157
+ 0.5.0:
158
+ * API CHANGE (as with all 0.x.0 changes) (towards ActiveRecord duck typing)
159
+ - Base#ldapattribute now always returns an array
160
+ - Base#ldapattribute(true) now returns a dup of an array, string, etc
161
+ when appropriate (old default) - This is just for convenience
162
+ - Base#ldapattribute returns the stored value, not just a .dup
163
+ - Associations methods return objects by default instead of just names.
164
+ Group.new('foo').members(false) will return names only.
165
+ - Base.connect returns true as one might expect
166
+ * Value validation and changing (binary, etc) occur prior to write, and
167
+ not immediately on attribute_method=(value).
168
+ * Attribute method validity is now determined /on-the-fly/.
169
+ * Default log level set to OFF speeds up 'speedtest' by 3 seconds!
170
+ (counters last point which added some slowness :)
171
+ * Added Schema2#class_attributes which caches and fully supertype expands
172
+ attribute lists.
173
+ * Integrated Schema2#class_attributes with apply_objectclass which automagically
174
+ does SUP traversal and automagically updates available methods on calls to
175
+ #attributes, #method_missing, #validate, and #write
176
+ * Added 'attributes' to 'methods' allowing for irb autocompletion and other
177
+ normal rubyisms
178
+ * Moved almost all validation to Base#validate to avoid unexpected exceptions
179
+ being raised in seemingly unrelated method calls. This means that invalid
180
+ objectClasses may be specified. This will only be caught on #write or
181
+ a pre-emptive #validate. This goes for all attribute errors though.
182
+ This also makes it possible to "break" objects by removing the 'top'
183
+ objectclass and therefore the #objectClass method...
184
+
185
+ 0.4.4:
186
+ * Fixed binary subtype forcing:
187
+ - was setting data as subtype ;binary even when not required
188
+ * Added first set of unit tests.
189
+ - These will be cleaned up in later releases as more tests are added.
190
+ * Fixed subtype clobber non-subtype (unittest!)
191
+ - cn and cn;lang-blah: the last loaded won
192
+ * Fixed multivalued subtypes from being shoved into a string (unittest!)
193
+ - an error with attribute_input_value
194
+
195
+ 0.4.3:
196
+ * Fixed write (add) bugs introduced with last change
197
+ - only bug fixes until unittests are in place
198
+
199
+ 0.4.2:
200
+ * Added ruby-activeldap.gemspec
201
+ * Integrated building a gem of 'ruby-activeldap' into Makefile.package
202
+ * Added attr parsing cache to speed up repetitive calls: approx 13x speedup
203
+ = 100 usermod-binary-add calls
204
+ - Without attr parsing cache:
205
+ real 13m53.129s
206
+ user 13m11.350s
207
+ sys 0m7.030s
208
+ - With attr parsing cache:
209
+ real 1m0.416s
210
+ user 0m28.390s
211
+ sys 0m2.380s
212
+
213
+ 0.4.1:
214
+ * Schema2 was not correctly parsing objectClass entries.
215
+ - This is fixed for now but must be revisited.
216
+
217
+ 0.4.0:
218
+ * Added #<attribute>(arrays) argument which when true
219
+ always returns arrays. e.g.
220
+ irb> user.cn(true)
221
+ => ['My Common Name']
222
+ This makes things easier for larger programming tasks.
223
+ * Added subtype support:
224
+ - Uses Hash objects to specify the subtype
225
+ e.g. user.userCertificate = {'binary' => File.read('mycert.der')}
226
+ - Added recursive type enforcement along with the subtype handling
227
+ - This required overhauling the #write method.
228
+ - Please report any problems ASAP! :^)
229
+ * Added automagic binary support
230
+ - subtype wrapping done automatically
231
+ - relies on X-NOT-HUMAN-READABLE flag
232
+ * Added LDAP::Schema2 which is an extension of Ruby/LDAP::Schema
233
+ - made Schema#attr generic for easy type dereferencing
234
+ * Updated rdoc in activeldap.rb
235
+ * Updated examples (poorly) to reflect new functionality
236
+ * Added several private helper functions
237
+
238
+ 0.3.6:
239
+ * Fixed dn attribute value extraction on find and find_all
240
+ - these may have grabbed the wrong value if a DN attr has
241
+ multiple values.
242
+ * Fixed Base.search to return all values as arrays and update
243
+ multivalued ones correctly
244
+ * Lowered the amount of default logging to FATAL only
245
+
246
+ 0.3.5:
247
+ * Moved to rubyforge.org!
248
+
249
+ 0.3.4:
250
+ * Changed license to Ruby's
251
+
252
+ 0.3.3:
253
+ * Changed Base.search to return an array instead of a hash of hashes
254
+ * Change Base.search to take in a hash as its arguments
255
+
256
+ 0.3.2:
257
+ * Bug fix - fixed support for module'd extension classes (again!)
258
+
259
+ 0.3.1:
260
+ * Updated the documentation
261
+ * Fixed ignoring of attrs argument in Base.search
262
+ * Fixed mistake in groupls (using dnattr directly)
263
+ * Fixed a mistake with overzealous dup'ing
264
+
265
+ 0.3.0:
266
+ * MORE API CHANGES (configuration.rb, etc)
267
+ * Major overhaul to the internals!
268
+ - removed @@BLAH[@klass] in lieu of defining
269
+ class methods which contain the required values. This
270
+ allows for clean inheritance of Base subclasses! Whew!
271
+ - Added @@config to store the options currently in use
272
+ after a Base.connect
273
+ - Now cache passwords for doing reconnects
274
+ - dnattr now accessible to the outside as a class method only
275
+ * Added Base.search to wrap normal LDAP search for convenience.
276
+ - This returns a hash of hashes with the results indexed first by
277
+ full dn, then by attribute.
278
+
279
+ 0.2.0:
280
+ * API CHANGES:
281
+ - Extension classes must be defined using map_to_ldap instead of setting
282
+ random values in initialize
283
+ - Base#find is now Base.find_all and is a class method
284
+ - Base.find returns the first match a la Array#find
285
+ - force_reload is gone in belongs_to and has_many created methods
286
+ - hiding Base.new, Base.find, and Base.find_all from direct access
287
+ * added uniq to setting objectClass to avoid stupid errors
288
+ * fixed new object creation bug where attributes were added before the
289
+ objectclass resulting in a violation (Base#write)
290
+ * fixed attribute dereferencing in Base#write
291
+ * fixed bug with .dup on Fixnums
292
+ * methods created by has_many/belongs_to and find and find_all now take an
293
+ optional argument dnattr_only which will return the value of dnattr for
294
+ each result instead of a full object.
295
+ * Base.connection=(conn) added for multiplexing connections
296
+ * Added a manual to activeldap.rb which covers most usage of Ruby/ActiveLDAP
297
+ * Base.connect(:try_sasl => true) should now work with GSSAPI if you are
298
+ using OpenLDAP >= 2.1.29
299
+
300
+ 0.1.8:
301
+ * .dup all returned attribute values to avoid weirdness
302
+ * .dup all assigned values to avoid weirdness
303
+ * Changed default configuration.rb to use example.com
304
+
305
+ 0.1.7:
306
+ * Added support for non-unique DN attributes
307
+ * Added authoritative DN retrieval with 'object.dn'
308
+
309
+ 0.1.6:
310
+ * Added Base.close method for clearing the existing connection (despite Ruby/LDAP's lack of .close)
311
+
312
+ 0.1.5:
313
+ * Fixed incorrect usage of @klass in .find (should .find be a class method?)
314
+
315
+ 0.1.4:
316
+ * Change WARN to INFO in associations.rb for has_many
317
+
318
+ 0.1.3:
319
+ * Fixed class name mangling
320
+ * Added support for classes to take DNs as the initialization value
321
+
322
+ 0.1.2:
323
+ * Patch from Dick Davies: Try SSL before TLS
324
+ * Log4r support
325
+ * Better packaging (automated)
326
+ * Work-around for SSL stupidity
327
+ - SSLConn doesn't check if the port it connected to is really using SSL!
328
+
329
+ 0.1.1:
330
+ * Dynamic table class creation
331
+ * SASL/GSSAPI disabled by default - doesn't work consistently
332
+
333
+ 0.1.0:
334
+ * Added foreign_key to has_many
335
+ * Added local_key to belongs_to
336
+ * Added primary_members to Group example
337
+ * Added "nil" filtering to has_many
338
+ * Packaged up with setup.rb
339
+ * Added RDocs and better comments
340
+
341
+ 0.0.9:
342
+ * Separated extension classes from ActiveLDAP module
343
+ * Cleaned up examples with new requires
344
+
345
+ 0.0.8:
346
+ * Added user and group scripting examples
347
+ - usermod, userls, useradd, userdel
348
+ - groupmod, groupls
349
+
350
+ 0.0.7:
351
+ * Cleaner authentication loop:
352
+ - SASL (GSSAPI only), simple, anonymous
353
+ * Added allow_anonymous option added (default: false)
354
+
355
+ 0.0.6:
356
+ * Write support cleaned up
357
+ * Exception classes added
358
+
359
+ 0.0.5:
360
+ * LDAP write support added
361
+
362
+ 0.0.4:
363
+ * MUST and MAY data validation against schema using objectClasses
364
+
365
+ 0.0.3:
366
+ * LDAP attributes alias resolution and data mapping
367
+
368
+ 0.0.2:
369
+ * Associations: has_many and belongs_to Class methods added for Base
370
+
371
+ 0.0.1:
372
+ * Extension approach in place with example User and Group classes
373
+
374
+ 0.0.0:
375
+ * Basic LDAP read support in place with hard-coded OUs
data/COPYING ADDED
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Library General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) year name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.