mip/Modules/MIP_FILES.pck

create or replace package MIP_FILES is

  -- Author  : PRIESTJ
  -- Created : 02/11/2007 10:59:52
  -- Purpose : Handle files for the webMIP system

  -- Public function and procedure declarations
function quote_file_exists(p_qute_id number) return boolean;
function delete_file(p_id number,p_doc_status varchar2,p_reason varchar2) return boolean;
function drawing_file_exists(p_drwg_code varchar2) return boolean;
function update_file_association(p_uri in varchar2,
                                p_description in varchar2,
                                p_docu_type in varchar2,
                                p_qute_id in number,
                                p_enqu_id in number,
                                p_drwg_code in varchar2) return boolean;
function set_file_association(p_uri in varchar2,
                              p_description in varchar2,
                              p_docu_type in varchar2,
                              p_rt_code in varchar2,
                              p_qute_id in number,
                              p_enqu_id in number,
                              p_drwg_code in varchar2,
                              p_doro_type in varchar2) return boolean;

PROCEDURE export_table_to_csv(p_table IN VARCHAR2,
                             p_column_headers IN VARCHAR2,
                             p_delimiter IN VARCHAR2 DEFAULT ',');


end MIP_FILES;
/
create or replace package body MIP_FILES as

PROCEDURE pl(p_in VARCHAR2) IS
    l_fh utl_file.file_type;
  BEGIN
    dbms_application_info.set_module('MIP_FILES'
                                    ,p_in);
    l_fh := utl_file.fopen(location  => 'WEBMIP_BULK_LOAD'
                          ,filename  => 'MIP_FILES.txt'
                          ,open_mode => 'A');
    utl_file.put_line(l_fh
                     ,to_char(SYSDATE
                             ,'DD/MM/YYYY HH24:MI:SS') || ',' || p_in);
    utl_file.fclose(l_fh);
  END pl;


  /*
   FUNCTION is_file_over_size_limit
   - takes the uri of the file to test for size and returns true if the file
   - is over 3 meg (3145728 bytes) in size
   %param p_uri - the uri of the file
  */
  function is_file_over_size_limit(p_uri varchar2) return boolean is
    l_file_size wwv_flow_files.doc_size%type;

  BEGIN

pl('is_file_over_size_limit:'||p_uri);
  SELECT doc_size
    INTO l_file_size
    FROM wwv_flow_files
   WHERE NAME = p_uri;
pl('l_file_size:'||l_file_size);
  RETURN(l_file_size > 3 * 1024 * 1024);

  end is_file_over_size_limit;
  /*
   FUNCTION are_files_over_size_limit
   - takes the enquiry id and an additional uri of the file to test for size
   - and returns true if all the current files and plus additional file pointed
   - by the uri are over 10 meg (10485760 bytes) in size
   %param p_enqu_id - id of the enquiry to check the files for
  */
  function are_files_over_size_limit(p_enqu_id NUMBER) return boolean is
    l_total_size number;
  BEGIN
pl('are_files_over_size_limit:'||p_enqu_id);
  SELECT SUM(doc_size)
    INTO l_total_size
    FROM documents      d
        ,document_roles dr
        ,wwv_flow_files f
   WHERE dr.enqu_id = p_enqu_id
     AND d.id = dr.docu_id
     AND d.uri = f.NAME;

pl('l_total_size:'||l_total_size);
  RETURN (nvl(l_total_size,0) > 10 * 1024 * 1024);

  end are_files_over_size_limit;
  /*
   FUNCTION delete_file
   - takes the id of a file held in the documents table and deletes the associated document
   - in the documents, document_roles and wwv_flow_files tables and view
   %param p_id - the id of the file
   %param p_doc_status - the new status of the document one of "REMOVED USER", "REMOVED MALICIOUS", "REMOVED SIZE"
   %param p_reason - a description of what the reason for deleting the file is
  */
  function delete_file(p_id number,p_doc_status varchar2,p_reason varchar2) return boolean is
    l_uri documents.uri%type;
    CURSOR c_get_uri(cp_id number) is
      select uri
      from documents
      where id=cp_id;
  begin
    IF NOT c_get_uri%ISOPEN THEN
      OPEN c_get_uri(p_id);
    END IF;
    FETCH c_get_uri
      INTO l_uri;
    CLOSE c_get_uri;
    --set up a deletion event for the document
    insert into document_events(docu_id, dost_code,event_date,description,id)
    values (p_id,
            p_doc_status,
            sysdate,
            p_reason,
            doev_seq.NEXTVAL);
    --delete the actual file from the database
    delete wwv_flow_files where wwv_flow_files.name = l_uri;
    return true;
  end delete_file;
    /*
   FUNCTION quote_file_exists
   - takes the quote id and searches for associated file in APEX Application
   - Files, returns true if the file exists or false if it does not exist
   %param p_qute_id - the quote id
  */
  function quote_file_exists(p_qute_id number) return boolean is
    l_file_exists  number;
    CURSOR c_file_exists(cp_qute_id number) IS
      select 1
      from wwv_flow_files
      where name=(select d.uri
                  from documents d, document_roles dr
                  where dr.qute_id = cp_qute_id and d.id = dr.docu_id);
  begin
    IF NOT c_file_exists%ISOPEN THEN
      OPEN c_file_exists(p_qute_id);
    END IF;
    FETCH c_file_exists
      INTO l_file_exists;
    CLOSE c_file_exists;
    if l_file_exists is not null and l_file_exists>0 then
      return true;
    else
      return false;
    end if;
  end quote_file_exists;
  /*
   FUNCTION drawing_file_exists
   - takes the drawing code and searches for associated file in APEX Application
   - Files, returns true if the file exists or false if it does not exist
   %param p_drwg_code - the drawing code
  */
  function drawing_file_exists(p_drwg_code varchar2) return boolean is
    l_file_exists  number;
    CURSOR c_file_exists(cp_drwg_code varchar2) IS
      select 1
      from wwv_flow_files
      where name=(select d.uri
                  from documents d, document_roles dr
                  where dr.drwg_code = cp_drwg_code and d.id = dr.docu_id);
  begin
    IF NOT c_file_exists%ISOPEN THEN
      OPEN c_file_exists(p_drwg_code);
    END IF;
    FETCH c_file_exists
      INTO l_file_exists;
    CLOSE c_file_exists;
    if l_file_exists is not null and l_file_exists>0 then
      return true;
    else
      return false;
    end if;
  end drawing_file_exists;
  /*
   FUNCTION update_file_association
   - updates the association between a object within webmip to a file held in the
   - APEX application files view and ophans any existing files.
   %param p_uri - the uri of the file (the contents of the name column in APEX application files)
   %param p_description - description of the file, will be set in documents and document_roles table
   %param p_docu_type - INDO (held within webmip db), EXDO (held outside webmip), FIDO (on file system)
   %param p_rt_code - type of role for docment eg 'ENQUIRY SUPPORTING DOC' see role types table
   %param p_qute_id - the quote id if applicable otherwise supply null
   %param p_enqu_id - the enquiry id if applicable otherwise supply null
   %param p_drwg_code - the drawing code if applicable otherwise supply null
  */
  function update_file_association(p_uri in varchar2,
                                p_description in varchar2,
                                p_docu_type in varchar2,
                                p_qute_id in number,
                                p_enqu_id in number,
                                p_drwg_code in varchar2) return boolean is
    l_doc_id number;

  begin
      --reference it in the documents table
      insert into documents( uri, description, id, docu_type )
      values (p_uri,
              p_description,
              docu_seq.NEXTVAL,
              p_docu_type)
      returning id into l_doc_id;
      --set up a role for the document
      update document_roles set docu_id = l_doc_id
      where drwg_code = nvl(p_drwg_code,'') or qute_id = nvl(p_qute_id,0) or enqu_id = nvl(p_enqu_id,0);
      --set up an event for the document
      insert into document_events(docu_id, dost_code,event_date,description,id)
      values (l_doc_id,
              'AWAIT SCAN',
              sysdate,
              p_description,
              doev_seq.NEXTVAL);
      --if it works then return true
      return true;
  end update_file_association;
  /*
   FUNCTION set_file_association
   - sets the association between a object within webmip to a file held in the
   - APEX application files view.
   %param p_uri - the uri of the file (the contents of the name column in APEX application files)
   %param p_description - description of the file, will be set in documents and document_roles table
   %param p_docu_type - INDO (held within webmip db), EXDO (held outside webmip), FIDO (on file system)
   %param p_rt_code - type of role for docment eg 'ENQUIRY SUPPORTING DOC' see role types table
   %param p_qute_id - the quote id if applicable otherwise supply null
   %param p_enqu_id - the enquiry id if applicable otherwise supply null
   %param p_drwg_code - the drawing code if applicable otherwise supply null
   %param p_doro_type - DRRO (for a drawing), ENDO (for an enquiry), QUDO (for a quote)
  */
  function set_file_association(p_uri in varchar2,
                                p_description in varchar2,
                                p_docu_type in varchar2,
                                p_rt_code in varchar2,
                                p_qute_id in number,
                                p_enqu_id in number,
                                p_drwg_code in varchar2,
                                p_doro_type in varchar2) return BOOLEAN is
    l_doc_id number;
    l_success boolean;
  BEGIN
  pl('set_file_association, p_uri='||p_uri||', p_drwg_code='||p_drwg_code);
      --reference it in the documents table
      insert into documents( uri, description, id, docu_type )
      values (p_uri,
              p_description,
              docu_seq.NEXTVAL,
              p_docu_type)
      returning id into l_doc_id;
      --set up a role for the document
      insert into document_roles(rt_code, start_date,description,qute_id,enqu_id,drwg_code,id,doro_type,docu_id)
      values (p_rt_code,
              sysdate,
              p_description,
              p_qute_id,
              p_enqu_id,
              p_drwg_code,
              doro_seq.NEXTVAL,
              p_doro_type,
              l_doc_id);
      --set up an event for the document
      insert into document_events(docu_id, dost_code,event_date,description,id)
      values (l_doc_id,
              'AWAIT SCAN',
              sysdate,
              p_description,
              doev_seq.NEXTVAL);
              
              pl('check_file_sizes');
    if (are_files_over_size_limit(p_enqu_id) or is_file_over_size_limit(p_uri)) and p_rt_code = 'ENQUIRY SUPPORTING DOC' and not p_enqu_id is null then
      l_success := delete_file(l_doc_id,'REMOVED SIZE','webMIP determined the file or files to be too big');
      pl('returning false'); 
      return false;
    else
      --if it works then return true
      pl('returning true');
      return true;
    end if;
  end set_file_association;
  /*
   PROCEDURE export_data_to_csv
   - allows an admin user to create a CSV export of a table in webMIP.
   - This function will be used to extract data from the online webMIP system
   - and pull the data into Metering I&C's backend systems.
   %param p_table - the name of the table we're to export
   %param p_column_headers - tables column names be exported as a header
   %param p_delimiter - what is the delimiter value is for each field (default ',')
  */
  PROCEDURE export_table_to_csv(p_table IN VARCHAR2,
                                p_column_headers IN VARCHAR2,
                                p_delimiter IN VARCHAR2 DEFAULT ',') is

    l_select VARCHAR2(2000); --will hold our dynamically created sql query
    l_cursor INTEGER DEFAULT dbms_sql.open_cursor; --a handle for the recordset we can then loop through
    l_status INTEGER;
    l_return VARCHAR2(4000);
    l_found  BOOLEAN := TRUE;
    l_headers VARCHAR(2000); --used to collect the column headers
  BEGIN
     dbms_output.put_line('me is here');
    -- Build the dynamic SQL statement to get the tables column names
    FOR f IN (SELECT column_name
            FROM   user_tab_columns
            WHERE  table_name = upper(p_table)
            ORDER  BY column_id) LOOP
      --
      -- AG's clever delimiting ensures that the rows from the table are output
      -- in a nice CSV format
      l_select := l_select ||'''"''||'|| f.column_name || '||''"'||p_delimiter||'''||';
      --
      -- Get the header row, slightly inefficient in that we may not need to
      -- do it every time
      l_headers := l_headers || f.column_name || p_delimiter;
      --
    END LOOP;
    --
    -- Trim the unnecessary additional delimiting chars on the headers and
    -- add a carriage return
    l_headers := RTRIM(l_headers,p_delimiter) || CHR(13);
    --
    -- build the dynamic SQL that will return all the table rows
    l_select := 'SELECT ' || RTRIM(l_select,'||') || CHR(13)||CHR(10) ||' FROM ' || p_table;
    --
    -- Now we have the select, let's execute it
    --
     dbms_output.put_line(l_select);
    dbms_sql.parse(l_cursor
                  ,l_select
                  ,dbms_sql.native);
    --
    dbms_sql.define_column(l_cursor
                          ,1
                          ,l_return
                          ,4000);
    --
    l_status := dbms_sql.execute(l_cursor); --could be used for further manipulation
    --
    WHILE (dbms_sql.fetch_rows(l_cursor) > 0) LOOP
      --
      IF l_found THEN
        --
        -- Set the header MIME type
        owa_util.mime_header( 'application/octet', FALSE );
        -- Set the name of the file
        htp.p('Content-Disposition: attachment; filename="'||lower(p_table)||'.csv"');
        -- Close the HTTP Header
        owa_util.http_header_close;
        --
        l_found := FALSE;
        --
        -- If the user has requested that the tables column names be exported
        -- then display them
        if upper(p_column_headers) = 'YES' then
          --print column headers
          htp.p(l_headers);
        end if;
        --
      END IF;
      --
      -- Main CSV output
      dbms_sql.column_value(l_cursor
                           ,1
                           ,l_return);
      --
      htp.p(l_return);
      --
    END LOOP;
    --
  END export_table_to_csv;

end MIP_FILES;
/