├── .gitignore ├── clsql-orm.asd ├── package.lisp ├── examples ├── generating-from-trac-postgresql-db.lisp └── generating-from-mssql-server.lisp ├── sqlite3.lisp ├── mysql.lisp ├── README.clsql-postgres-introspect ├── README.md ├── main.lisp └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .svn 2 | build 3 | dist 4 | Thumbs.db 5 | thumbs.db 6 | *~ 7 | *# 8 | *.fasl 9 | etc/apache.conf 10 | /etc/init.d 11 | bin/newsite.localgetaways.com 12 | doc/Local-Getaways-Jesse-Template 13 | doc/Montery Bay Inn FINAL 14 | bin/www.localgetaways.com 15 | etc/redirect.localgetaways.com.conf 16 | logs 17 | bin 18 | -------------------------------------------------------------------------------- /clsql-orm.asd: -------------------------------------------------------------------------------- 1 | ;-*- mode: lisp -*- 2 | (eval-when (:compile-toplevel :load-toplevel :execute) 3 | (unless (find-package :clsql-orm.system) 4 | (defpackage :clsql-orm.system 5 | (:use :common-lisp :asdf)))) 6 | 7 | (in-package :clsql-orm.system) 8 | 9 | (defsystem clsql-orm 10 | :depends-on (:clsql :cl-ppcre :cl-interpol :cl-inflector :symbol-munger :iterate) 11 | :version "0.2" 12 | :serial T 13 | :components ((:file "package") 14 | (:file "sqlite3") 15 | (:file "mysql") 16 | (:file "main"))) 17 | -------------------------------------------------------------------------------- /package.lisp: -------------------------------------------------------------------------------- 1 | (defpackage #:clsql-orm 2 | (:use :cl :clsql :iterate) 3 | (:shadow #:list-tables ) 4 | (:export :gen-view-class 5 | :gen-view-classes 6 | :gen-view-classes-for-database 7 | :list-foreign-constraints 8 | :not-null-p 9 | :unique-p 10 | :primary-key-p 11 | :clsql-type-for-pg-type 12 | :list-columns 13 | :column-def 14 | :column 15 | :db-type 16 | :spec-type 17 | :is-null 18 | :scale 19 | :col-length 20 | :col= 21 | :column-name= 22 | :column-diff) 23 | (:documentation "This package provides methods to introspect a database 24 | Providing features such as generating a CLSQL class based on a table name")) 25 | -------------------------------------------------------------------------------- /examples/generating-from-trac-postgresql-db.lisp: -------------------------------------------------------------------------------- 1 | (defpackage :clsql-orm-pg-example 2 | (:use :cl :cl-user)) 3 | 4 | (in-package :clsql-orm-pg-example) 5 | 6 | (eval-when (:compile-toplevel :load-toplevel :execute) 7 | (defclass pg-db-class (CLSQL-SYS::STANDARD-DB-CLASS) 8 | ()) 9 | (defclass pg-db-obj (CLSQL-SYS::STANDARD-DB-OBJECT) 10 | () 11 | (:METACLASS pg-db-class))) 12 | 13 | (defmethod generate-view-classes () 14 | (clsql-sys:with-database 15 | (clsql-sys:*default-database* 16 | `("host" "database" "user" "password") 17 | :pool nil 18 | :database-type :postgresql-socket 19 | :if-exists :warn-new) 20 | ;; generate classes from the trac database into the current package 21 | ;; These symbols will not automatically be 22 | (clsql-orm:gen-view-classes 23 | ;; in the public schema 24 | :schema "public" 25 | ;; for each of these table names 26 | :classes '(ticket ticket_change recent_ticket_changes recent_wiki_changes) 27 | :metaclass 'pg-db-class 28 | :inherits-from '(pg-db-obj)) 29 | 30 | )) 31 | -------------------------------------------------------------------------------- /examples/generating-from-mssql-server.lisp: -------------------------------------------------------------------------------- 1 | (defpackage :clsql-orm-mssql-example (:use :cl :cl-user)) 2 | (in-package :clsql-orm-mssql-example) 3 | 4 | (eval-when (:compile-toplevel :load-toplevel :execute) 5 | (defclass mssql-db-class (CLSQL-SYS::STANDARD-DB-CLASS) 6 | ()) 7 | (defclass mssql-db-obj (CLSQL-SYS::STANDARD-DB-OBJECT) 8 | () 9 | (:METACLASS mssql-db-class))) 10 | 11 | (defmethod generate-view-classes () 12 | (clsql-sys:with-database 13 | (clsql-sys:*default-database* 14 | `("DSN-NAME" "USER-NAME" "PASSWORD") 15 | :pool T 16 | :make-default nil 17 | :database-type :odbc 18 | :if-exists :warn-new) 19 | 20 | (clsql-orm:gen-view-classes 21 | ;; Generate all these in a new 22 | ;; package named :clsql-orm-mssql-example-objects 23 | ;; :nicknames :adwolf-db 24 | :package :clsql-orm-mssql-example-objects 25 | :nicknames :mssql-objs 26 | 27 | ;; set each class inheritance chain 28 | :inherits-from '(clsql:mssql-db-object) 29 | ;; set each classes metaclass 30 | :metaclass 'mssql-db-class 31 | 32 | ;; should we automatically export the symbols we create from the 33 | ;; package above 34 | :export-symbols T 35 | 36 | ;; SQLServer Owner 37 | :schema "dbo" 38 | 39 | ;; Should we try to singularize the class names we create from the table 40 | ;; eg: Services -> adwolf-db:service when T 41 | ;; & Services -> adwolf-db:services when nil 42 | :singularize nil))) -------------------------------------------------------------------------------- /sqlite3.lisp: -------------------------------------------------------------------------------- 1 | (in-package :clsql-orm) 2 | (cl-interpol:enable-interpol-syntax) 3 | (clsql-sys:file-enable-sql-reader-syntax) 4 | 5 | (defun sqlite3-list-tables (&key (schema *schema*) (owner nil)) 6 | (declare (ignore schema)) 7 | (iter top 8 | (for (type names) in 9 | `(("TABLE" ,(clsql-sys:list-tables :owner owner :database clsql-sys:*default-database*)) 10 | ("VIEW" ,(clsql-sys:list-views :owner owner :database clsql-sys:*default-database*)))) 11 | (iter (for i in names) 12 | (in top (collect (list i type)))))) 13 | 14 | (defun sqlite3-column-def (table column-name type is-null? default pk?) 15 | (let ((db-type (let ((idx (position #\( type))) 16 | (intern-normalize-for-lisp 17 | (if idx (subseq type 0 idx) type) 18 | :keyword)))) 19 | (make-instance 'column-def 20 | :schema *schema* 21 | :table table 22 | :column column-name 23 | :default default 24 | :db-type db-type 25 | :is-null (eql is-null? 0) 26 | :constraints (when (= pk? 1) (list :primary-key)) 27 | :spec-type db-type))) 28 | 29 | (defun sqlite3-list-columns (table &optional (schema *schema*)) 30 | (declare (ignore schema)) 31 | (iter 32 | (for col in (clsql:query #?"PRAGMA table_info(${table});")) 33 | ;; (for (col-idx column-name type is-null? default pk?) = col) 34 | (collect (apply #'sqlite3-column-def table (cdr col))))) 35 | -------------------------------------------------------------------------------- /mysql.lisp: -------------------------------------------------------------------------------- 1 | (in-package :clsql-orm) 2 | (cl-interpol:enable-interpol-syntax) 3 | (clsql-sys:file-enable-sql-reader-syntax) 4 | 5 | (defun mysql-list-columns-sql (schema table reverse-joins? &aux where order) 6 | (setf where 7 | (if reverse-joins? 8 | #?"fkey.referenced_table_name = '${table}' AND fkey.referenced_table_schema = '${schema}'" 9 | #?"cols.table_schema ='${schema}' AND cols.table_name ='${table}'")) 10 | (setf order 11 | (if reverse-joins? 12 | #?"fkey.referenced_table_name, fkey.referenced_column_name" 13 | #?"cols.table_name, cols.column_name, cols.data_type")) 14 | #?" 15 | SELECT 16 | cols.table_schema, 17 | cols.table_name, 18 | cols.column_name, cols.data_type, 19 | COALESCE(cols.character_maximum_length, 20 | cols.numeric_precision), 21 | cols.numeric_scale, 22 | cols.is_nullable, 23 | cols.column_default, 24 | cons.constraint_type, 25 | fkey.referenced_table_schema, 26 | fkey.referenced_table_name, 27 | fkey.referenced_column_name 28 | FROM information_schema.columns AS cols 29 | LEFT JOIN information_schema.key_column_usage AS fkey 30 | ON fkey.column_name = cols.column_name 31 | AND fkey.table_name = cols.table_name 32 | AND fkey.table_schema = cols.table_schema 33 | LEFT JOIN information_schema.table_constraints AS cons 34 | ON cons.constraint_name = fkey.constraint_name 35 | AND cons.constraint_schema = fkey.constraint_schema 36 | AND cons.table_name = fkey.table_name 37 | AND cons.table_schema = fkey.table_schema 38 | 39 | WHERE ${where} 40 | 41 | ORDER BY ${order} 42 | ") 43 | -------------------------------------------------------------------------------- /README.clsql-postgres-introspect: -------------------------------------------------------------------------------- 1 | CLSQL-PG-INTROSPECT 2 | ------------------- 3 | 4 | Use this package to help with introspective operations on Postgres 5 | databases. 6 | 7 | Some small examples of some basic operations follow. 8 | 9 | (gen-view-class music) 10 | 11 | Would take the music table and define a clsql class based upon it. 12 | This currently includes designating primary keys, not-null 13 | constraints, unique constraints, and joins on foreign tables. 14 | 15 | (gen-view-class musicians :classname music-people) 16 | 17 | Defines a class MUSIC-PEOPLE based on table musicians. This is best to 18 | avoid if you can, as then autogenerated foreign relations won't work. 19 | 20 | (gen-view-class music :generate-joins nil) 21 | 22 | Defines class MUSIC, but without the joins. 23 | 24 | By default, accessors are generated, named after the columns. To turn this 25 | off, pass :generate-accessors nil to gen-view-class. 26 | 27 | Accessors/slots for joins are named [home key]-[target table] 28 | 29 | Besides this main utility, there are functions for: 30 | - determining if a column has any of the following restrictions: 31 | + not-null (not-null-p) 32 | + unique (unique-p) 33 | + is a primary key (primary-key-p) 34 | - listing all foreign constraints of a table (list-foreign-constraints) 35 | - listing all user columns of a table and their type (user-columns) 36 | - figuring out a clsql type given a PostgreSQL type (clsql-type-for-pg-type) 37 | 38 | 39 | Most of the functionality is wrapped up in one simple macro: 40 | (defmacro gen-view-classes-for-database ((connection-spec database-type &key (generate-joins t) (generate-accessors t)) &rest classes) 41 | 42 | That'll do it for you. 43 | 44 | Of course, database-type has to be :postgresql. The option is in for...forwards compatibility? 45 | 46 | Bug reports and patches gladly accepted. 47 | 48 | Thanks, 49 | Alan Shields 50 | Alan-Shields@omrf.ouhsc.edu 51 | 52 | This work was made possible by the Centola Lab of the Oklahoma Medical 53 | Research Foundation 54 | 55 | License information is in the file LICENSE 56 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CLSQL-ORM # 2 | Use this package to help with introspective operations against 3 | databases that support information_schema . It supports generating 4 | view-class definitions from the database schema. 5 | 6 | This was originally clsql-postgres-introspect, though this is a bit far removed from that. 7 | 8 | I have used this to successfully generate view-classes for PostgreSQL, 9 | MSSQL (through freetds and unixodbc), and mysql. 10 | 11 | This project does not attempt to be a persistence layer. It also makes quite a few assumptions 12 | about what should be generated and with what types that may not match your desires or existing 13 | notions. As such this code might only be useful as a jumping off point for creating your own 14 | custom clsql ORM. 15 | 16 | ## Examples ## 17 | 18 | **Please see the examples directory** 19 | 20 | ``` 21 | (with-a-database (*application*) ;; a clsql-helper macro that sets up clsql:*default-database* 22 | (clsql-orm:gen-view-classes 23 | :inherits-from '(pg-db-obj) ;; a class I have that I want all my pg-db-objects to inherit from 24 | :classes 25 | ;; The tables I want to turn into classes 26 | '(users user_districts_and_counties titles salaries roles fiscal-years expenses budgets counties 27 | districts counties-with-districts reports data-entry-finalizations 28 | specialties bad-state-salary-input races))) 29 | ``` 30 | 31 | ``` 32 | (clsql-orm:gen-view-classes 33 | :inherits-from '(pg-db-obj) ;; a class I have that I want all my pg-db-objects to inherit from 34 | :classes 35 | ;; The tables I want to turn into classes 36 | '(users)) 37 | 38 | ;;; Results in the following class definition being evaled: 39 | (def-view-class user (pg-db-obj) 40 | ((date-entered :column date_entered :accessor date-entered 41 | :db-constraints nil :type wall-time :initarg 42 | date-entered) 43 | (deleted :column deleted :accessor deleted :db-constraints nil 44 | :type boolean :initarg deleted) 45 | (email :column email :accessor email :db-constraints (not-null) 46 | :type (varchar 128) :initarg email) 47 | (enabled :column enabled :accessor enabled :db-constraints 48 | (not-null) :initform t :type boolean :initarg enabled) 49 | (first-name :column first_name :accessor first-name 50 | :db-constraints nil :initform nil :type varchar 51 | :initarg first-name) 52 | (id :column id :accessor id :db-kind key :db-constraints 53 | (not-null) :type integer :initarg id) 54 | (last-name :column last_name :accessor last-name :db-constraints 55 | nil :initform nil :type varchar :initarg last-name) 56 | (password :column password :accessor password :db-constraints 57 | (not-null) :type (varchar 32) :initarg password) 58 | (role-id :column role_id :accessor role-id :db-constraints 59 | (not-null) :type integer :initarg role-id) 60 | (role-join :accessor role-join :db-kind join :db-info 61 | (join-class role :home-key role-id :foreign-key id 62 | :set nil)) 63 | (salt :column salt :accessor salt :db-constraints (not-null) :type 64 | (varchar 4) :initarg salt)) 65 | (base-table users)) 66 | 67 | ``` 68 | ## Authors 69 | ### Authors of this Branch ### 70 | 71 | * [Acceleration.net] (http://www.acceleration.net/) 72 | * [Russ Tyndall](http://russ.unwashedmeme.com/blog) 73 | * [Nathan Bird](http://the.unwashedmeme.com/blog) 74 | * [Ryan Davis](http://ryepup.unwashedmeme.com/blog) 75 | 76 | ### Author of MySQL Bug Fixes ### 77 | 78 | Scott Brown 79 | 80 | ### Original Author information ### 81 | 82 | Alan Shields 83 | 84 | This work was made possible by the Centola Lab of the Oklahoma Medical Research Foundation 85 | 86 | License information is in the file LICENSE (LLGPL) 87 | -------------------------------------------------------------------------------- /main.lisp: -------------------------------------------------------------------------------- 1 | (in-package :clsql-orm) 2 | (cl-interpol:enable-interpol-syntax) 3 | (clsql-sys:file-enable-sql-reader-syntax) 4 | (defvar *schema* () "The schema we are generating from " ) 5 | (defvar *export-symbols* () "Should we export every symbol we intern? " ) 6 | (defvar *singularize* () "Should we try to singularize table names " ) 7 | (defvar *db-model-package* *package*) 8 | 9 | ;;;;; Utilities 10 | (defun ensure-list (x) (typecase x (list x) (t (list x)))) 11 | (defmacro awhen (cond &body body) 12 | `(let ((it ,cond)) (when it ,@body))) 13 | 14 | (defmacro ensure-strings ((&rest vars) &body body) 15 | `(let ,(loop for var in vars 16 | collect `(,var (if (stringp ,var) 17 | ,var 18 | (symbol-name ,var)))) 19 | ,@body)) 20 | 21 | 22 | (defun internup (me &optional (package *db-model-package*)) 23 | (let ((r (intern (string-upcase me) package))) 24 | (when *export-symbols* (export r package)) 25 | r)) 26 | 27 | (defun intern-normalize-for-lisp (me &optional (package *db-model-package*)) 28 | "Interns a string after uppercasing and flipping underscores to hyphens" 29 | (let ((r (symbol-munger:underscores->lisp-symbol me package))) 30 | (when *export-symbols* (export r package)) 31 | r)) 32 | 33 | (defun singular-intern-normalize-for-lisp (me &optional (package *db-model-package*)) 34 | "Interns a string after uppercasing and flipping underscores to hyphens" 35 | (let ((words (reverse (cl-ppcre:split "-|_" (string me)))) 36 | (cl-interpol:*list-delimiter* "-")) 37 | (setf (first words) (cl-inflector:singular-of (first words))) 38 | (internup #?"@{ (reverse words) }" package))) 39 | 40 | (defun normalize-for-sql (s) 41 | (symbol-munger:lisp->underscores s :capitalize nil)) 42 | 43 | (defun clsql-join-column-name (table ref-table colname) 44 | (declare (ignorable table) 45 | (ignorable ref-table)) 46 | (let ((colname (princ-to-string (intern-normalize-for-lisp colname)))) 47 | (intern-normalize-for-lisp 48 | (cl-ppcre:regex-replace-all (cl-ppcre:create-scanner 49 | "^(.*?)\-?(id|key)?$" 50 | :case-insensitive-mode T) 51 | colname "\\1-JOIN")))) 52 | 53 | (defun type-of-db () 54 | "Returns the underlying db type for the dynamic connection" 55 | (clsql-sys::database-underlying-type clsql-sys:*default-database*)) 56 | 57 | (defun accessor-name-for-column (table column) 58 | (let ((default-sym (intern-normalize-for-lisp column))) 59 | (if (eql (symbol-package default-sym) (find-package :cl)) 60 | (intern-normalize-for-lisp #?"${table}.${column}") 61 | default-sym))) 62 | 63 | (defclass column-def () 64 | ((schema :accessor schema :initarg :schema :initform *schema*) 65 | (table :accessor table :initarg :table :initform nil) 66 | (column :accessor column :initform nil :initarg :column) 67 | (db-type :accessor db-type :initform nil :initarg :db-type) 68 | (spec-type :accessor spec-type :initform nil :initarg :spec-type 69 | :documentation "the original database type rather than its clsql/lisp keyword") 70 | (col-length :accessor col-length :initform nil :initarg :col-length) 71 | (scale :accessor scale :initform nil :initarg :scale) 72 | (is-null :accessor is-null :initform nil :initarg :is-null) 73 | (default :accessor default :initform nil :initarg :default) 74 | (constraints :accessor constraints :initform nil :initarg :constraints) 75 | (fkey-schema :accessor fkey-schema :initform nil :initarg :fkey-schema) 76 | (fkey-table :accessor fkey-table :initform nil :initarg :fkey-table) 77 | (fkey-col :accessor fkey-col :initform nil :initarg :fkey-col))) 78 | 79 | (defun col= (c1 c2) 80 | (and (typep c1 'column-def) (typep c2 'column-def) 81 | (string-equal (clsql-orm::table c1) (clsql-orm::table c2)) 82 | (string-equal (clsql-orm:column c1) (clsql-orm:column c2)) 83 | (string-equal (clsql-orm:spec-type c1) (clsql-orm:spec-type c2)))) 84 | 85 | (defun column-name= (c1 c2) 86 | (and (typep c1 'column-def) (typep c2 'column-def) 87 | (string-equal (schema c1) (schema c2)) 88 | (string-equal (table c1) (table c2)) 89 | (string-equal (column c1) (column c2)))) 90 | 91 | (defmethod print-object ((o column-def) s) 92 | "Print the database object, and a couple of the most common identity slots." 93 | (print-unreadable-object (o s :type t :identity t) 94 | (format s "~@[~a.~]~a.~A" 95 | (ignore-errors (schema o)) 96 | (ignore-errors (table o)) 97 | (ignore-errors (column o))))) 98 | 99 | (defun column-def (schema table column db-type col-length 100 | scale is-null default constraints 101 | fkey-schema fkey-table fkey-col) 102 | (make-instance 'column-def 103 | :schema schema 104 | :table table 105 | :column column :db-type db-type :col-length col-length 106 | :scale scale 107 | :is-null is-null :default default :constraints constraints 108 | :fkey-schema fkey-schema :fkey-table fkey-table :fkey-col fkey-col 109 | :spec-type db-type)) 110 | 111 | (defun clsql-column-definitions (table &key 112 | (schema *schema*) 113 | (generate-accessors t) 114 | (generate-joins T)) 115 | "For each user column, find out if it's a primary key, constrain it to not null if necessary, 116 | translate its type, and declare an initarg" 117 | (let ((cols (list-columns table schema))) 118 | (unless cols 119 | (error "Could not find any columns for table: ~a in schema: ~a. 120 | Are you sure you correctly spelled the table name? 121 | Are you sure you sure this database connection has access to the table?" 122 | table schema)) 123 | (iter (for col in cols) 124 | (with-accessors ((column column) (db-type db-type) (col-length col-length) 125 | (is-null is-null) (default default) (constraints constraints) 126 | (fkey-table fkey-table) (fkey-col fkey-col)) col 127 | (when (and is-null default) 128 | (warn "CLSQL-ORM: The column ~a.~a.~a should not be null and have a default value (~a)" 129 | schema table column default)) 130 | ;; TODO: add a "skip column" and "use explict type" restart 131 | (collect `(,(intern-normalize-for-lisp column) 132 | :column ,column 133 | ,@(when generate-accessors 134 | `(:accessor ,(accessor-name-for-column table column))) 135 | ,@(when (member :primary-key constraints) 136 | '(:db-kind :key)) 137 | :db-constraints 138 | ( 139 | ,@(unless is-null '(:not-null)) 140 | ,@(when (and (member :primary-key constraints) 141 | (identity-column-p table column)) 142 | '(:identity)) 143 | ) 144 | ,@(cond 145 | ( ;; its null with no default 146 | (and is-null (null default)) 147 | '(:initform nil)) 148 | 149 | ;; we have a not-nullable boolean column 150 | ;; (which should have a default) 151 | ((and (not is-null) (eql db-type :boolean) default) 152 | `(:initform ,(not (or (string-equal default "false") 153 | (string-equal default "0")))) 154 | ) 155 | ) 156 | :type ,(clsql-type-for-db-type db-type col-length) 157 | :initarg ,(intern-normalize-for-lisp column :keyword))) 158 | (when (and 159 | generate-joins 160 | (member :foreign-key constraints)) 161 | (if (and fkey-table fkey-col) 162 | (collect (clsql-join-definition table column fkey-table fkey-col 163 | :generate-accessors generate-accessors)) 164 | (warn "CLSQL-ORM: Could not generate a join for: ~a.~a.~a because we couldnt read the relationship. Perhaps your permissions should be adjusted" 165 | schema table column))))))) 166 | 167 | (defun clsql-join-definition (home-table home-key foreign-table foreign-key 168 | &key (generate-accessors t)) 169 | "Creates the definition for the joins. Note that this does not handle multi-column foreign keys at the moment. 170 | For that matter, if you wish to have custom names and the like, you'd best define an inheriting class" 171 | (let ((varname (clsql-join-column-name home-table foreign-table home-key))) 172 | `(,varname 173 | ,@(when generate-accessors 174 | `(:accessor ,varname)) 175 | :db-kind :join 176 | :db-info (:join-class ,(if *singularize* 177 | (singular-intern-normalize-for-lisp foreign-table) 178 | (intern-normalize-for-lisp foreign-table)) 179 | :home-key ,(intern-normalize-for-lisp home-key) 180 | :foreign-key ,(intern-normalize-for-lisp foreign-key) 181 | :set nil 182 | ; ,@(if (unique-p join-class foreign-key) 183 | ; '(:set nil) 184 | ; '(:set t)) 185 | )))) 186 | 187 | (defun clsql-reverse-join-definition (column-def 188 | &key (generate-accessors t)) 189 | (let* ((include-schema? (not (string-equal (schema column-def) 190 | (fkey-schema column-def)))) 191 | (foreign-table (table column-def)) 192 | (home-key (fkey-col column-def)) 193 | (foreign-key (column column-def)) 194 | (varname (clsql-orm::intern-normalize-for-lisp 195 | (list 196 | (when include-schema? (schema column-def)) 197 | foreign-table foreign-key 'join)))) 198 | `(,varname 199 | ,@(when generate-accessors 200 | `(:accessor ,varname)) 201 | :db-kind :join 202 | :db-info (:join-class ,(if *singularize* 203 | (singular-intern-normalize-for-lisp foreign-table) 204 | (intern-normalize-for-lisp foreign-table)) 205 | :home-key ,(intern-normalize-for-lisp home-key) 206 | :foreign-key ,(intern-normalize-for-lisp foreign-key) 207 | :set t 208 | )))) 209 | 210 | (defun clsql-reverse-join-definitions ( table &key (schema *schema*)) 211 | (let ((columns (list-reverse-join-columns table :schema schema))) 212 | (iter (for c in columns) 213 | (collect (clsql-reverse-join-definition 214 | c))))) 215 | 216 | ;;;;; External-ish functions 217 | 218 | (defun identity-column-p (table column) 219 | "a function that can determine if a key column is IDENTITY for sqlserver" 220 | (when (and (find-package :clsql-odbc) 221 | (typep clsql-sys:*default-database* 222 | (intern "ODBC-DATABASE" :clsql-odbc))) 223 | (setf table (clsql-sys:sql-escape-quotes (normalize-for-sql table))) 224 | (setf column (clsql-sys:sql-escape-quotes (normalize-for-sql column))) 225 | (handler-case 226 | (eql 1 (first (clsql:query #?"select COLUMNPROPERTY(object_id('${table}'), '${column}', 'IsIdentity')" 227 | :flatp T))) 228 | (error (c) 229 | (warn "Error querying about IDENTITY ~a" c))))) 230 | 231 | (defun list-columns (table &optional (schema *schema*)) 232 | (case (type-of-db) 233 | (:sqlite3 (sqlite3-list-columns table schema)) 234 | (T (default-list-columns table :schema schema)))) 235 | 236 | (defun list-reverse-join-columns (table &key (schema *schema*)) 237 | (default-list-columns table :schema schema :reverse-joins? t)) 238 | 239 | (defun default-list-columns-sql (schema table reverse-joins? &aux where order) 240 | (setf where 241 | (if reverse-joins? 242 | #?"fkey.table_name = '${table}' and fkey.table_schema= '${schema}'" 243 | #?"cols.table_schema ='${schema}' AND cols.table_name ='${table}'")) 244 | (setf order 245 | (if reverse-joins? 246 | #?"fkey.table_name, fkey.column_name" 247 | #?"cols.table_name, cols.column_name, cols.data_type")) 248 | #?" 249 | SELECT 250 | cols.table_schema, 251 | cols.table_name, 252 | cols.column_name, cols.data_type, 253 | COALESCE(cols.character_maximum_length, 254 | cols.numeric_precision), 255 | cols.numeric_scale, 256 | cols.is_nullable, 257 | cols.column_default, 258 | cons.constraint_type, 259 | fkey.table_schema, 260 | fkey.table_name, 261 | fkey.column_name 262 | 263 | FROM information_schema.columns as cols 264 | LEFT JOIN information_schema.key_column_usage as keycols 265 | ON keycols.column_name = cols.column_name 266 | AND keycols.table_name = cols.table_name 267 | AND keycols.table_schema = cols.table_schema 268 | LEFT JOIN information_schema.table_constraints as cons 269 | ON cons.constraint_name = keycols.constraint_name 270 | AND cons.constraint_schema = cons.constraint_schema 271 | 272 | LEFT JOIN information_schema.referential_constraints as refs 273 | ON refs.constraint_schema = cons.constraint_schema 274 | AND refs.constraint_name = cons.constraint_name 275 | 276 | LEFT JOIN information_schema.key_column_usage as fkey 277 | ON fkey.constraint_schema = refs.unique_constraint_schema 278 | AND fkey.constraint_name = refs.unique_constraint_name 279 | 280 | WHERE ${where} 281 | 282 | ORDER BY ${order} 283 | ") 284 | 285 | (defun default-list-columns-lesser-sql (schema table) 286 | "A fallback sql for databases whose information_schema is 287 | lacking (previously mysql, but perhaps others)" 288 | #?" 289 | SELECT 290 | DISTINCT 291 | cols.table_name, 292 | cols.column_name, cols.data_type, 293 | COALESCE(cols.character_maximum_length, 294 | cols.numeric_precision), 295 | cols.numeric_scale, 296 | cols.is_nullable, 297 | cols.column_default, 298 | null as constraint_type, 299 | null as table_name, 300 | null as column_name 301 | 302 | FROM information_schema.columns as cols 303 | LEFT JOIN information_schema.key_column_usage as keycols 304 | ON keycols.column_name = cols.column_name 305 | AND keycols.table_name = cols.table_name 306 | AND keycols.table_schema = cols.table_schema 307 | 308 | WHERE cols.table_schema ='${schema}' AND cols.table_name ='${table}' 309 | ORDER BY cols.table_name, cols.column_name, cols.data_type 310 | ") 311 | 312 | (defun default-list-columns ( table &key (schema *schema*) (reverse-joins? nil )) 313 | "Returns a list of 314 | #(column type length is-null default (key-types) fkey-table fkey-col) 315 | for the user columns of table. 316 | Do not confuse a table with the clsql class of a table - this needs the actual table name. 317 | User columns are those columns which the user defines. Others are defined for various reasons. OID is often 318 | one of these." 319 | (declare (type (or string symbol) table)) 320 | 321 | (setf table (clsql-sys:sql-escape-quotes (normalize-for-sql table))) 322 | (setf schema (clsql-sys:sql-escape-quotes (normalize-for-sql schema))) 323 | (let* ((sql (case (type-of-db) 324 | (:mysql (mysql-list-columns-sql schema table reverse-joins?)) 325 | (t (default-list-columns-sql schema table reverse-joins?)))) 326 | (lesser-sql (default-list-columns-lesser-sql schema table)) 327 | (results (or (clsql:query sql :flatp T) 328 | (and (not reverse-joins?) 329 | (clsql:query lesser-sql :flatp T))))) 330 | (iter 331 | (with prev-row) 332 | (for l-row in results) 333 | (for row = (apply #'column-def l-row)) 334 | (cond 335 | ((column-name= row prev-row) ;; new constraint for prev-row 336 | (push (symbol-munger:english->keyword (constraints row)) 337 | (constraints prev-row)) 338 | (awhen (fkey-table row) 339 | (setf (fkey-table prev-row) it)) 340 | (awhen (fkey-col row) 341 | (setf (fkey-col prev-row) it))) 342 | (T ;; new column 343 | (setf (db-type row) (symbol-munger:english->keyword (db-type row))) 344 | (setf (is-null row) (string-equal (is-null row) "YES")) 345 | (setf (constraints row) (list (symbol-munger:english->keyword (constraints row)))) 346 | (collect row) 347 | (setf prev-row row)))))) 348 | 349 | 350 | ;; TODO: add condition for don't know how to convert db type 351 | 352 | (defun clsql-type-for-db-type (db-type len) 353 | "Given a postgres type and a modifier, return the clsql type" 354 | (declare (type symbol db-type) 355 | (type (or integer null) len)) 356 | (ecase db-type 357 | ((:smallint :tinyint :bigint :int :int2 :int4 :int8 :integer) 358 | 'integer) 359 | ((:float :float2 :float4 :float8 :double-precision) 360 | 'double-float) 361 | ((:text :ntext :longtext) 'varchar) 362 | ;; weird Postgresql types 363 | ((:point :user-defined) 'varchar) 364 | ((:char :bpchar :varchar :nvarchar :character-varying :character :string) 365 | (if len `(varchar ,len) 'varchar)) 366 | ((:numeric :decimal :money) 367 | 'number) 368 | ((:datetime 369 | :timestamptz 370 | :timestamp 371 | :timestamp-with-time-zone 372 | :timestamp-without-time-zone) 373 | 'clsql-sys::wall-time) 374 | ((:date :smalldatetime) 375 | 'date) 376 | (:interval 'duration) 377 | (:uniqueidentifier 'number) 378 | ((:bool :boolean :bit) 'boolean) 379 | ((:inet :cidr) '(varchar 43)) ; 19 for IPv4, 43 for IPv6 380 | (:macaddr '(varchar 17)) 381 | (:uuid '(varchar 36)) ; eg a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11 382 | (:image '(vector (unsigned-byte 8))) 383 | )) 384 | 385 | 386 | (defun list-tables (&optional (schema *schema*)) 387 | (case (type-of-db) 388 | (:sqlite3 (sqlite3-list-tables :schema schema)) 389 | (T 390 | (clsql:select [table_name] [table_type] 391 | :from [information_schema.tables] 392 | :flatp T 393 | :where [= [UPPER [table_schema]] (string-upcase schema)])))) 394 | 395 | (defun column-diff (table-1 table-2 &key (schema-1 *schema*) (schema-2 *schema*)) 396 | (let ((cols1 (list-columns table-1 schema-1)) 397 | (cols2 (list-columns table-2 schema-2))) 398 | (list 399 | (iter (for c in cols1) 400 | (unless (find c cols2 :test #'col=) (collect c))) 401 | (iter (for c in cols2) 402 | (unless (find c cols1 :test #'col=) (collect c)))) 403 | )) 404 | 405 | (defun gen-view-class (table &key classname 406 | (is-view nil) 407 | (generate-joins t) 408 | (generate-reverse-joins t) 409 | (generate-accessors t) 410 | (inherits-from ()) 411 | (view-inherits-from ()) 412 | (package *package*) 413 | (nicknames ()) 414 | (singularize T) 415 | (schema "public") 416 | (metaclass ()) 417 | (slots ()) 418 | (export-symbols ()) 419 | (print? nil)) 420 | "Generate a view class for clsql, given a table 421 | If you want to name the class differently from the table, use the :classname keyword. 422 | If you do not want to generate join information for the class, do :generate-joins nil 423 | Note: if you specify a classname, join generation to this table won't work properly, as it depends on 424 | table names and class names being the same. 425 | 426 | The join slots/accessors will be named [home key]-[target table]. If you want to have your own 427 | naming conventions, it's best to define a class that inherits from your generated class." 428 | (declare (type (or symbol string) table)) 429 | (unless view-inherits-from (setf view-inherits-from inherits-from)) 430 | (restart-case 431 | (ensure-strings (table schema) 432 | (let* ((*schema* schema) 433 | (*export-symbols* export-symbols) 434 | (*singularize* singularize) 435 | (*db-model-package* (or (find-package package) 436 | (make-package package :nicknames (ensure-list nicknames) :use ()))) 437 | (class (or classname 438 | (and singularize 439 | (singular-intern-normalize-for-lisp table)) 440 | (intern-normalize-for-lisp table))) 441 | (columns (clsql-column-definitions 442 | table 443 | :generate-accessors generate-accessors 444 | :generate-joins generate-joins)) 445 | (reverse-joins (when generate-reverse-joins 446 | (clsql-reverse-join-definitions table)))) 447 | (let ((form `(clsql:def-view-class ,class (,@(if is-view view-inherits-from inherits-from)) 448 | ,(append columns reverse-joins slots) 449 | (:base-table ,table) 450 | ,@(when metaclass 451 | `((:metaclass ,metaclass)))))) 452 | (when print? (format *trace-output* "~%~s~%" form)) 453 | (eval form)))) 454 | (skip-view-class () 455 | :report (lambda (str) (format str "Skip generating class for table ~a" table))))) 456 | 457 | (defun %tables-to-generate (classes excludes schema) 458 | (setf excludes (mapcar #'princ-to-string (ensure-list excludes))) 459 | (flet ((exclude? (table) 460 | (member table excludes :test #'string-equal))) 461 | (if classes 462 | (iter (for class in classes) 463 | ;; building (table-name type) where type is VIEW or TABLE 464 | (for c = (typecase class 465 | (list (normalize-for-sql (first class)) 466 | (second class)) 467 | (symbol (list (normalize-for-sql class) nil)) 468 | (string (list class nil)))) 469 | (unless (exclude? (first c)) (collect c))) 470 | (iter (for pair in (list-tables schema)) 471 | (unless (exclude? (first pair)) 472 | (collect pair)))))) 473 | 474 | (defun gen-view-classes (&key 475 | (classes) 476 | (excludes) 477 | (generate-joins t) 478 | (generate-reverse-joins t) 479 | (generate-accessors t) 480 | (schema "public") 481 | (package *package*) 482 | (export-symbols ()) 483 | (nicknames ()) 484 | (singularize T) 485 | (inherits-from ()) 486 | (view-inherits-from ()) 487 | (metaclass ())) 488 | "This is the function most people will use to generate table classes. It uses gen-view-class. 489 | 490 | This function will operate on the default clsql database 491 | " 492 | (unless view-inherits-from (setf view-inherits-from inherits-from)) 493 | (setf classes (%tables-to-generate classes excludes schema)) 494 | (iter (for (table type) in classes) 495 | (gen-view-class 496 | table 497 | :generate-joins generate-joins 498 | :generate-reverse-joins generate-reverse-joins 499 | :is-view (string-equal type "VIEW") 500 | :view-inherits-from view-inherits-from 501 | :inherits-from inherits-from 502 | :singularize singularize 503 | :export-symbols export-symbols 504 | :schema schema 505 | :package package 506 | :nicknames (ensure-list nicknames) 507 | :metaclass metaclass 508 | :generate-accessors generate-accessors))) 509 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | This code is placed under the LGPL with the following preamble. 2 | This is usually known as the LLGPL. 3 | 4 | The work itself is Copyright (c) 2005 Alan Shields 5 | 6 | -------------------------------------------------------------- 7 | License text is 8 | Copyright (c) 2000 Franz Incorporated, Berkeley, CA 94704 9 | 10 | The concept of the GNU Lesser General Public License version 2.1 11 | ("LGPL") has been adopted to govern the use and distribution of 12 | above-mentioned application. However, the LGPL uses terminology that 13 | is more appropriate for a program written in C than one written in 14 | Lisp. Nevertheless, the LGPL can still be applied to a Lisp program if 15 | certain clarifications are made. This document details those 16 | clarifications. Accordingly, the license for the open-source Lisp 17 | applications consists of this document plus the LGPL. Wherever there 18 | is a conflict between this document and the LGPL, this document takes 19 | precedence over the LGPL. 20 | 21 | A "Library" in Lisp is a collection of Lisp functions, data and 22 | foreign modules. The form of the Library can be Lisp source code (for 23 | processing by an interpreter) or object code (usually the result of 24 | compilation of source code or built with some other 25 | mechanisms). Foreign modules are object code in a form that can be 26 | linked into a Lisp executable. When we speak of functions we do so in 27 | the most general way to include, in addition, methods and unnamed 28 | functions. Lisp "data" is also a general term that includes the data 29 | structures resulting from defining Lisp classes. A Lisp application 30 | may include the same set of Lisp objects as does a Library, but this 31 | does not mean that the application is necessarily a "work based on the 32 | Library" it contains. 33 | 34 | The Library consists of everything in the distribution file set before 35 | any modifications are made to the files. If any of the functions or 36 | classes in the Library are redefined in other files, then those 37 | redefinitions ARE considered a work based on the Library. If 38 | additional methods are added to generic functions in the Library, 39 | those additional methods are NOT considered a work based on the 40 | Library. If Library classes are subclassed, these subclasses are NOT 41 | considered a work based on the Library. If the Library is modified to 42 | explicitly call other functions that are neither part of Lisp itself 43 | nor an available add-on module to Lisp, then the functions called by 44 | the modified Library ARE considered a work based on the Library. The 45 | goal is to ensure that the Library will compile and run without 46 | getting undefined function errors. 47 | 48 | It is permitted to add proprietary source code to the Library, but it 49 | must be done in a way such that the Library will still run without 50 | that proprietary code present. Section 5 of the LGPL distinguishes 51 | between the case of a library being dynamically linked at runtime and 52 | one being statically linked at build time. Section 5 of the LGPL 53 | states that the former results in an executable that is a "work that 54 | uses the Library." Section 5 of the LGPL states that the latter 55 | results in one that is a "derivative of the Library", which is 56 | therefore covered by the LGPL. Since Lisp only offers one choice, 57 | which is to link the Library into an executable at build time, we 58 | declare that, for the purpose applying the LGPL to the Library, an 59 | executable that results from linking a "work that uses the Library" 60 | with the Library is considered a "work that uses the Library" and is 61 | therefore NOT covered by the LGPL. 62 | 63 | Because of this declaration, section 6 of LGPL is not applicable to 64 | the Library. However, in connection with each distribution of this 65 | executable, you must also deliver, in accordance with the terms and 66 | conditions of the LGPL, the source code of Library (or your derivative 67 | thereof) that is incorporated into this executable. 68 | 69 | ------------------------------------------------------------------- 70 | 71 | GNU LESSER GENERAL PUBLIC LICENSE 72 | Version 2.1, February 1999 73 | 74 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 75 | 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 76 | Everyone is permitted to copy and distribute verbatim copies 77 | of this license document, but changing it is not allowed. 78 | 79 | [This is the first released version of the Lesser GPL. It also counts 80 | as the successor of the GNU Library Public License, version 2, hence 81 | the version number 2.1.] 82 | 83 | Preamble 84 | 85 | The licenses for most software are designed to take away your 86 | freedom to share and change it. By contrast, the GNU General Public 87 | Licenses are intended to guarantee your freedom to share and change 88 | free software--to make sure the software is free for all its users. 89 | 90 | This license, the Lesser General Public License, applies to some 91 | specially designated software packages--typically libraries--of the 92 | Free Software Foundation and other authors who decide to use it. You 93 | can use it too, but we suggest you first think carefully about whether 94 | this license or the ordinary General Public License is the better 95 | strategy to use in any particular case, based on the explanations below. 96 | 97 | When we speak of free software, we are referring to freedom of use, 98 | not price. Our General Public Licenses are designed to make sure that 99 | you have the freedom to distribute copies of free software (and charge 100 | for this service if you wish); that you receive source code or can get 101 | it if you want it; that you can change the software and use pieces of 102 | it in new free programs; and that you are informed that you can do 103 | these things. 104 | 105 | To protect your rights, we need to make restrictions that forbid 106 | distributors to deny you these rights or to ask you to surrender these 107 | rights. These restrictions translate to certain responsibilities for 108 | you if you distribute copies of the library or if you modify it. 109 | 110 | For example, if you distribute copies of the library, whether gratis 111 | or for a fee, you must give the recipients all the rights that we gave 112 | you. You must make sure that they, too, receive or can get the source 113 | code. If you link other code with the library, you must provide 114 | complete object files to the recipients, so that they can relink them 115 | with the library after making changes to the library and recompiling 116 | it. And you must show them these terms so they know their rights. 117 | 118 | We protect your rights with a two-step method: (1) we copyright the 119 | library, and (2) we offer you this license, which gives you legal 120 | permission to copy, distribute and/or modify the library. 121 | 122 | To protect each distributor, we want to make it very clear that 123 | there is no warranty for the free library. Also, if the library is 124 | modified by someone else and passed on, the recipients should know 125 | that what they have is not the original version, so that the original 126 | author's reputation will not be affected by problems that might be 127 | introduced by others. 128 | 129 | Finally, software patents pose a constant threat to the existence of 130 | any free program. We wish to make sure that a company cannot 131 | effectively restrict the users of a free program by obtaining a 132 | restrictive license from a patent holder. Therefore, we insist that 133 | any patent license obtained for a version of the library must be 134 | consistent with the full freedom of use specified in this license. 135 | 136 | Most GNU software, including some libraries, is covered by the 137 | ordinary GNU General Public License. This license, the GNU Lesser 138 | General Public License, applies to certain designated libraries, and 139 | is quite different from the ordinary General Public License. We use 140 | this license for certain libraries in order to permit linking those 141 | libraries into non-free programs. 142 | 143 | When a program is linked with a library, whether statically or using 144 | a shared library, the combination of the two is legally speaking a 145 | combined work, a derivative of the original library. The ordinary 146 | General Public License therefore permits such linking only if the 147 | entire combination fits its criteria of freedom. The Lesser General 148 | Public License permits more lax criteria for linking other code with 149 | the library. 150 | 151 | We call this license the "Lesser" General Public License because it 152 | does Less to protect the user's freedom than the ordinary General 153 | Public License. It also provides other free software developers Less 154 | of an advantage over competing non-free programs. These disadvantages 155 | are the reason we use the ordinary General Public License for many 156 | libraries. However, the Lesser license provides advantages in certain 157 | special circumstances. 158 | 159 | For example, on rare occasions, there may be a special need to 160 | encourage the widest possible use of a certain library, so that it becomes 161 | a de-facto standard. To achieve this, non-free programs must be 162 | allowed to use the library. A more frequent case is that a free 163 | library does the same job as widely used non-free libraries. In this 164 | case, there is little to gain by limiting the free library to free 165 | software only, so we use the Lesser General Public License. 166 | 167 | In other cases, permission to use a particular library in non-free 168 | programs enables a greater number of people to use a large body of 169 | free software. For example, permission to use the GNU C Library in 170 | non-free programs enables many more people to use the whole GNU 171 | operating system, as well as its variant, the GNU/Linux operating 172 | system. 173 | 174 | Although the Lesser General Public License is Less protective of the 175 | users' freedom, it does ensure that the user of a program that is 176 | linked with the Library has the freedom and the wherewithal to run 177 | that program using a modified version of the Library. 178 | 179 | The precise terms and conditions for copying, distribution and 180 | modification follow. Pay close attention to the difference between a 181 | "work based on the library" and a "work that uses the library". The 182 | former contains code derived from the library, whereas the latter must 183 | be combined with the library in order to run. 184 | 185 | GNU LESSER GENERAL PUBLIC LICENSE 186 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 187 | 188 | 0. This License Agreement applies to any software library or other 189 | program which contains a notice placed by the copyright holder or 190 | other authorized party saying it may be distributed under the terms of 191 | this Lesser General Public License (also called "this License"). 192 | Each licensee is addressed as "you". 193 | 194 | A "library" means a collection of software functions and/or data 195 | prepared so as to be conveniently linked with application programs 196 | (which use some of those functions and data) to form executables. 197 | 198 | The "Library", below, refers to any such software library or work 199 | which has been distributed under these terms. A "work based on the 200 | Library" means either the Library or any derivative work under 201 | copyright law: that is to say, a work containing the Library or a 202 | portion of it, either verbatim or with modifications and/or translated 203 | straightforwardly into another language. (Hereinafter, translation is 204 | included without limitation in the term "modification".) 205 | 206 | "Source code" for a work means the preferred form of the work for 207 | making modifications to it. For a library, complete source code means 208 | all the source code for all modules it contains, plus any associated 209 | interface definition files, plus the scripts used to control compilation 210 | and installation of the library. 211 | 212 | Activities other than copying, distribution and modification are not 213 | covered by this License; they are outside its scope. The act of 214 | running a program using the Library is not restricted, and output from 215 | such a program is covered only if its contents constitute a work based 216 | on the Library (independent of the use of the Library in a tool for 217 | writing it). Whether that is true depends on what the Library does 218 | and what the program that uses the Library does. 219 | 220 | 1. You may copy and distribute verbatim copies of the Library's 221 | complete source code as you receive it, in any medium, provided that 222 | you conspicuously and appropriately publish on each copy an 223 | appropriate copyright notice and disclaimer of warranty; keep intact 224 | all the notices that refer to this License and to the absence of any 225 | warranty; and distribute a copy of this License along with the 226 | Library. 227 | 228 | You may charge a fee for the physical act of transferring a copy, 229 | and you may at your option offer warranty protection in exchange for a 230 | fee. 231 | 232 | 2. You may modify your copy or copies of the Library or any portion 233 | of it, thus forming a work based on the Library, and copy and 234 | distribute such modifications or work under the terms of Section 1 235 | above, provided that you also meet all of these conditions: 236 | 237 | a) The modified work must itself be a software library. 238 | 239 | b) You must cause the files modified to carry prominent notices 240 | stating that you changed the files and the date of any change. 241 | 242 | c) You must cause the whole of the work to be licensed at no 243 | charge to all third parties under the terms of this License. 244 | 245 | d) If a facility in the modified Library refers to a function or a 246 | table of data to be supplied by an application program that uses 247 | the facility, other than as an argument passed when the facility 248 | is invoked, then you must make a good faith effort to ensure that, 249 | in the event an application does not supply such function or 250 | table, the facility still operates, and performs whatever part of 251 | its purpose remains meaningful. 252 | 253 | (For example, a function in a library to compute square roots has 254 | a purpose that is entirely well-defined independent of the 255 | application. Therefore, Subsection 2d requires that any 256 | application-supplied function or table used by this function must 257 | be optional: if the application does not supply it, the square 258 | root function must still compute square roots.) 259 | 260 | These requirements apply to the modified work as a whole. If 261 | identifiable sections of that work are not derived from the Library, 262 | and can be reasonably considered independent and separate works in 263 | themselves, then this License, and its terms, do not apply to those 264 | sections when you distribute them as separate works. But when you 265 | distribute the same sections as part of a whole which is a work based 266 | on the Library, the distribution of the whole must be on the terms of 267 | this License, whose permissions for other licensees extend to the 268 | entire whole, and thus to each and every part regardless of who wrote 269 | it. 270 | 271 | Thus, it is not the intent of this section to claim rights or contest 272 | your rights to work written entirely by you; rather, the intent is to 273 | exercise the right to control the distribution of derivative or 274 | collective works based on the Library. 275 | 276 | In addition, mere aggregation of another work not based on the Library 277 | with the Library (or with a work based on the Library) on a volume of 278 | a storage or distribution medium does not bring the other work under 279 | the scope of this License. 280 | 281 | 3. You may opt to apply the terms of the ordinary GNU General Public 282 | License instead of this License to a given copy of the Library. To do 283 | this, you must alter all the notices that refer to this License, so 284 | that they refer to the ordinary GNU General Public License, version 2, 285 | instead of to this License. (If a newer version than version 2 of the 286 | ordinary GNU General Public License has appeared, then you can specify 287 | that version instead if you wish.) Do not make any other change in 288 | these notices. 289 | 290 | Once this change is made in a given copy, it is irreversible for 291 | that copy, so the ordinary GNU General Public License applies to all 292 | subsequent copies and derivative works made from that copy. 293 | 294 | This option is useful when you wish to copy part of the code of 295 | the Library into a program that is not a library. 296 | 297 | 4. You may copy and distribute the Library (or a portion or 298 | derivative of it, under Section 2) in object code or executable form 299 | under the terms of Sections 1 and 2 above provided that you accompany 300 | it with the complete corresponding machine-readable source code, which 301 | must be distributed under the terms of Sections 1 and 2 above on a 302 | medium customarily used for software interchange. 303 | 304 | If distribution of object code is made by offering access to copy 305 | from a designated place, then offering equivalent access to copy the 306 | source code from the same place satisfies the requirement to 307 | distribute the source code, even though third parties are not 308 | compelled to copy the source along with the object code. 309 | 310 | 5. A program that contains no derivative of any portion of the 311 | Library, but is designed to work with the Library by being compiled or 312 | linked with it, is called a "work that uses the Library". Such a 313 | work, in isolation, is not a derivative work of the Library, and 314 | therefore falls outside the scope of this License. 315 | 316 | However, linking a "work that uses the Library" with the Library 317 | creates an executable that is a derivative of the Library (because it 318 | contains portions of the Library), rather than a "work that uses the 319 | library". The executable is therefore covered by this License. 320 | Section 6 states terms for distribution of such executables. 321 | 322 | When a "work that uses the Library" uses material from a header file 323 | that is part of the Library, the object code for the work may be a 324 | derivative work of the Library even though the source code is not. 325 | Whether this is true is especially significant if the work can be 326 | linked without the Library, or if the work is itself a library. The 327 | threshold for this to be true is not precisely defined by law. 328 | 329 | If such an object file uses only numerical parameters, data 330 | structure layouts and accessors, and small macros and small inline 331 | functions (ten lines or less in length), then the use of the object 332 | file is unrestricted, regardless of whether it is legally a derivative 333 | work. (Executables containing this object code plus portions of the 334 | Library will still fall under Section 6.) 335 | 336 | Otherwise, if the work is a derivative of the Library, you may 337 | distribute the object code for the work under the terms of Section 6. 338 | Any executables containing that work also fall under Section 6, 339 | whether or not they are linked directly with the Library itself. 340 | 341 | 6. As an exception to the Sections above, you may also combine or 342 | link a "work that uses the Library" with the Library to produce a 343 | work containing portions of the Library, and distribute that work 344 | under terms of your choice, provided that the terms permit 345 | modification of the work for the customer's own use and reverse 346 | engineering for debugging such modifications. 347 | 348 | You must give prominent notice with each copy of the work that the 349 | Library is used in it and that the Library and its use are covered by 350 | this License. You must supply a copy of this License. If the work 351 | during execution displays copyright notices, you must include the 352 | copyright notice for the Library among them, as well as a reference 353 | directing the user to the copy of this License. Also, you must do one 354 | of these things: 355 | 356 | a) Accompany the work with the complete corresponding 357 | machine-readable source code for the Library including whatever 358 | changes were used in the work (which must be distributed under 359 | Sections 1 and 2 above); and, if the work is an executable linked 360 | with the Library, with the complete machine-readable "work that 361 | uses the Library", as object code and/or source code, so that the 362 | user can modify the Library and then relink to produce a modified 363 | executable containing the modified Library. (It is understood 364 | that the user who changes the contents of definitions files in the 365 | Library will not necessarily be able to recompile the application 366 | to use the modified definitions.) 367 | 368 | b) Use a suitable shared library mechanism for linking with the 369 | Library. A suitable mechanism is one that (1) uses at run time a 370 | copy of the library already present on the user's computer system, 371 | rather than copying library functions into the executable, and (2) 372 | will operate properly with a modified version of the library, if 373 | the user installs one, as long as the modified version is 374 | interface-compatible with the version that the work was made with. 375 | 376 | c) Accompany the work with a written offer, valid for at 377 | least three years, to give the same user the materials 378 | specified in Subsection 6a, above, for a charge no more 379 | than the cost of performing this distribution. 380 | 381 | d) If distribution of the work is made by offering access to copy 382 | from a designated place, offer equivalent access to copy the above 383 | specified materials from the same place. 384 | 385 | e) Verify that the user has already received a copy of these 386 | materials or that you have already sent this user a copy. 387 | 388 | For an executable, the required form of the "work that uses the 389 | Library" must include any data and utility programs needed for 390 | reproducing the executable from it. However, as a special exception, 391 | the materials to be distributed need not include anything that is 392 | normally distributed (in either source or binary form) with the major 393 | components (compiler, kernel, and so on) of the operating system on 394 | which the executable runs, unless that component itself accompanies 395 | the executable. 396 | 397 | It may happen that this requirement contradicts the license 398 | restrictions of other proprietary libraries that do not normally 399 | accompany the operating system. Such a contradiction means you cannot 400 | use both them and the Library together in an executable that you 401 | distribute. 402 | 403 | 7. You may place library facilities that are a work based on the 404 | Library side-by-side in a single library together with other library 405 | facilities not covered by this License, and distribute such a combined 406 | library, provided that the separate distribution of the work based on 407 | the Library and of the other library facilities is otherwise 408 | permitted, and provided that you do these two things: 409 | 410 | a) Accompany the combined library with a copy of the same work 411 | based on the Library, uncombined with any other library 412 | facilities. This must be distributed under the terms of the 413 | Sections above. 414 | 415 | b) Give prominent notice with the combined library of the fact 416 | that part of it is a work based on the Library, and explaining 417 | where to find the accompanying uncombined form of the same work. 418 | 419 | 8. You may not copy, modify, sublicense, link with, or distribute 420 | the Library except as expressly provided under this License. Any 421 | attempt otherwise to copy, modify, sublicense, link with, or 422 | distribute the Library is void, and will automatically terminate your 423 | rights under this License. However, parties who have received copies, 424 | or rights, from you under this License will not have their licenses 425 | terminated so long as such parties remain in full compliance. 426 | 427 | 9. You are not required to accept this License, since you have not 428 | signed it. However, nothing else grants you permission to modify or 429 | distribute the Library or its derivative works. These actions are 430 | prohibited by law if you do not accept this License. Therefore, by 431 | modifying or distributing the Library (or any work based on the 432 | Library), you indicate your acceptance of this License to do so, and 433 | all its terms and conditions for copying, distributing or modifying 434 | the Library or works based on it. 435 | 436 | 10. Each time you redistribute the Library (or any work based on the 437 | Library), the recipient automatically receives a license from the 438 | original licensor to copy, distribute, link with or modify the Library 439 | subject to these terms and conditions. You may not impose any further 440 | restrictions on the recipients' exercise of the rights granted herein. 441 | You are not responsible for enforcing compliance by third parties with 442 | this License. 443 | 444 | 11. If, as a consequence of a court judgment or allegation of patent 445 | infringement or for any other reason (not limited to patent issues), 446 | conditions are imposed on you (whether by court order, agreement or 447 | otherwise) that contradict the conditions of this License, they do not 448 | excuse you from the conditions of this License. If you cannot 449 | distribute so as to satisfy simultaneously your obligations under this 450 | License and any other pertinent obligations, then as a consequence you 451 | may not distribute the Library at all. For example, if a patent 452 | license would not permit royalty-free redistribution of the Library by 453 | all those who receive copies directly or indirectly through you, then 454 | the only way you could satisfy both it and this License would be to 455 | refrain entirely from distribution of the Library. 456 | 457 | If any portion of this section is held invalid or unenforceable under any 458 | particular circumstance, the balance of the section is intended to apply, 459 | and the section as a whole is intended to apply in other circumstances. 460 | 461 | It is not the purpose of this section to induce you to infringe any 462 | patents or other property right claims or to contest validity of any 463 | such claims; this section has the sole purpose of protecting the 464 | integrity of the free software distribution system which is 465 | implemented by public license practices. Many people have made 466 | generous contributions to the wide range of software distributed 467 | through that system in reliance on consistent application of that 468 | system; it is up to the author/donor to decide if he or she is willing 469 | to distribute software through any other system and a licensee cannot 470 | impose that choice. 471 | 472 | This section is intended to make thoroughly clear what is believed to 473 | be a consequence of the rest of this License. 474 | 475 | 12. If the distribution and/or use of the Library is restricted in 476 | certain countries either by patents or by copyrighted interfaces, the 477 | original copyright holder who places the Library under this License may add 478 | an explicit geographical distribution limitation excluding those countries, 479 | so that distribution is permitted only in or among countries not thus 480 | excluded. In such case, this License incorporates the limitation as if 481 | written in the body of this License. 482 | 483 | 13. The Free Software Foundation may publish revised and/or new 484 | versions of the Lesser General Public License from time to time. 485 | Such new versions will be similar in spirit to the present version, 486 | but may differ in detail to address new problems or concerns. 487 | 488 | Each version is given a distinguishing version number. If the Library 489 | specifies a version number of this License which applies to it and 490 | "any later version", you have the option of following the terms and 491 | conditions either of that version or of any later version published by 492 | the Free Software Foundation. If the Library does not specify a 493 | license version number, you may choose any version ever published by 494 | the Free Software Foundation. 495 | 496 | 14. If you wish to incorporate parts of the Library into other free 497 | programs whose distribution conditions are incompatible with these, 498 | write to the author to ask for permission. For software which is 499 | copyrighted by the Free Software Foundation, write to the Free 500 | Software Foundation; we sometimes make exceptions for this. Our 501 | decision will be guided by the two goals of preserving the free status 502 | of all derivatives of our free software and of promoting the sharing 503 | and reuse of software generally. 504 | 505 | NO WARRANTY 506 | 507 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 508 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 509 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 510 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 511 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 512 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 513 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 514 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 515 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 516 | 517 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 518 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 519 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 520 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 521 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 522 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 523 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 524 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 525 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 526 | DAMAGES. 527 | 528 | END OF TERMS AND CONDITIONS --------------------------------------------------------------------------------