MDL-38750 show errors at the end of OCI setup script
[moodle.git] / lib / dml / oci_native_moodle_package.sql
1 -- This file is part of Moodle - http://moodle.org/
2 --
3 -- Moodle is free software: you can redistribute it and/or modify
4 -- it under the terms of the GNU General Public License as published by
5 -- the Free Software Foundation, either version 3 of the License, or
6 -- (at your option) any later version.
7 --
8 -- Moodle is distributed in the hope that it will be useful,
9 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
10 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 -- GNU General Public License for more details.
12 --
13 -- You should have received a copy of the GNU General Public License
14 -- along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * @package    core_dml
18  * @copyright  2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
19  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
20  * @version    20091010 (plz, keep this updated for easier reference)
21  */
23 /**
24  * This sql script generates various PL/SQL packages needed to provide
25  * cross-db compatibility in the Moodle 2.x DB API with some operations
26  * not natively supported by Oracle, namely:
27  *  - locking: Application locks used by Moodle DB sessions. It uses
28  *             the DBMS_LOCK package so execution must be granted
29  *             to the Moodle DB user by SYS to work properly.
30  *  - bit ops: To provide cross-db bitwise operations to be used by the
31  *             sql_bitXXX() helper functions
32  *  - one space hacks: One space empty string substitute hacks.
33  */
35 CREATE OR REPLACE PACKAGE MOODLELIB AS
37 FUNCTION BITOR (value1 IN INTEGER, value2 IN INTEGER) RETURN INTEGER;
38 FUNCTION BITXOR(value1 IN INTEGER, value2 IN INTEGER) RETURN INTEGER;
40 FUNCTION GET_HANDLE  (lock_name IN VARCHAR2) RETURN VARCHAR2;
41 FUNCTION GET_LOCK    (lock_name IN VARCHAR2, lock_timeout IN INTEGER) RETURN INTEGER;
42 FUNCTION RELEASE_LOCK(lock_name IN VARCHAR2) RETURN INTEGER;
44 FUNCTION DIRTY_HACK(somestring IN VARCHAR2) RETURN VARCHAR2;
45 FUNCTION UNDO_DIRTY_HACK(hackedstring IN VARCHAR2) RETURN VARCHAR2;
47 END MOODLELIB;
48 /
50 CREATE OR REPLACE PACKAGE BODY MOODLELIB AS
52 FUNCTION BITOR(value1 IN INTEGER, value2 IN INTEGER) RETURN INTEGER IS
54 BEGIN
55     RETURN value1 + value2 - BITAND(value1,value2);
56 END BITOR;
58 FUNCTION BITXOR(value1 IN INTEGER, value2 IN INTEGER) RETURN INTEGER IS
60 BEGIN
61     RETURN MOODLELIB.BITOR(value1,value2) - BITAND(value1,value2);
62 END BITXOR;
64 FUNCTION GET_HANDLE(lock_name IN VARCHAR2) RETURN VARCHAR2 IS
65     PRAGMA AUTONOMOUS_TRANSACTION;
66     lock_handle VARCHAR2(128);
68 BEGIN
69     DBMS_LOCK.ALLOCATE_UNIQUE (
70         lockname => lock_name,
71         lockhandle => lock_handle,
72         expiration_secs => 864000);
73     RETURN lock_handle;
74 END GET_HANDLE;
76 FUNCTION GET_LOCK(lock_name IN VARCHAR2, lock_timeout IN INTEGER) RETURN INTEGER IS
77     lock_status NUMBER;
78 BEGIN
79     lock_status := DBMS_LOCK.REQUEST(
80                        lockhandle => GET_HANDLE(lock_name),
81                        lockmode => DBMS_LOCK.X_MODE, -- eXclusive
82                        timeout => lock_timeout,
83                        release_on_commit => FALSE);
84     CASE lock_status
85         WHEN 0 THEN NULL;
86         WHEN 2 THEN RAISE_APPLICATION_ERROR(-20000,'deadlock detected');
87         WHEN 4 THEN RAISE_APPLICATION_ERROR(-20000,'lock already obtained');
88         ELSE RAISE_APPLICATION_ERROR(-20000,'request lock failed - ' || lock_status);
89     END CASE;
90     RETURN 1;
91 END GET_LOCK;
93 FUNCTION RELEASE_LOCK(lock_name IN VARCHAR2) RETURN INTEGER IS
94     lock_status NUMBER;
95 BEGIN
96     lock_status := DBMS_LOCK.RELEASE(
97                       lockhandle => GET_HANDLE(lock_name));
98     IF lock_status > 0 THEN
99         RAISE_APPLICATION_ERROR(-20000,'release lock failed - ' || lock_status);
100     END IF;
101     RETURN 1;
102 END RELEASE_LOCK;
104 FUNCTION DIRTY_HACK(somestring IN VARCHAR2) RETURN VARCHAR2 IS
106 BEGIN
107     IF somestring = '' THEN
108       RETURN ' ';
109     END IF;
110     RETURN somestring;
111 END DIRTY_HACK;
113 FUNCTION UNDO_DIRTY_HACK(hackedstring IN VARCHAR2) RETURN VARCHAR2 IS
115 BEGIN
116     IF hackedstring = ' ' THEN
117         RETURN '';
118     END IF;
119     RETURN hackedstring;
120 END UNDO_DIRTY_HACK;
122 END MOODLELIB;
125 SHOW ERRORS