home *** CD-ROM | disk | FTP | other *** search
/ PC Pro 2003 March / DPPCPRO0303.ISO / Components / Microsoft ASP / _SETUP.1 / MSDBConnection.inc < prev    next >
Encoding:
Text File  |  1998-11-20  |  8.0 KB  |  216 lines
  1. </SCRIPT><SCRIPT RUNAT=SERVER LANGUAGE=JSCRIPT>
  2. <!--#INCLUDE FILE="MSGlobal.inc"-->
  3. ////////////////////////////////////////////////////////////////////
  4. //                                                                //
  5. //   NetObjects Fusion ASP Components                             //
  6. //   Custom JScript Object: MSDBConnection                       // 
  7. //                                                                //
  8. ////////////////////////////////////////////////////////////////////
  9. /*
  10. Object:       MSDBConnection 
  11.  
  12. Version:      1.0  9/23/97
  13.  
  14. Written By:   Application Methods, Inc.
  15.               6300 Southcenter Blvd.
  16.               Seattle, WA 98188
  17.               (206) 244-2400
  18.               http://www.appmethods.com
  19.  
  20. DESCRIPTION: This object definition describes properties and methods for a dynamically created
  21. ASP database connection. This function allows a developer to pass a set of database
  22. parameters to the object and connect to a database. The parameters are defined as follows
  23.  
  24.    
  25. Properties:
  26.     name             - The name of the MSDBConnection object
  27.     databaseType     - Type of connection, e.g. ODBC, native driver, etc.  All connections are ODBC for these components.
  28.     ODBCDatabaseType - One of the supported ODBC database types, such as MS Access, MS SQL Server, etc.
  29.     databaseServer   - The name of your data source pointing to the appropriate database.
  30.     username         - The name of the user allowed DB access
  31.     password         - associated pass word for the above user
  32.     globalConn       - a string representation of a boolean value indicating whether or not the global.asa file will
  33.                        be used to establish the database connection (if true) or one DBConnection component
  34.                        per page will be used (false).
  35.  
  36. Methods:
  37.    connect             - Connects to database
  38.    disconnect         - Disconnects from database
  39.    connected         - Returns whether the database is currently connected
  40.    render             - renders hidden visual elements of database component 
  41.    emitProperties     - emits database component's properties
  42.  
  43. NOTE: All of the above parameters may not be meaningful based on the type of connection
  44. that is selected. Please consult the ASP manual and the database vendor for details.
  45.  
  46. Note: Generation of a number of hidden fields is necessary to pass information
  47.    on to other components.  All hidden fields created by this object are prefixed
  48.    with 'amaspHidden_' or 'amaspComponent_'.  Developers should never create
  49.    any form element with these prefixes or unexpected results will occur.
  50.  
  51.  
  52. USAGE:
  53. <HTML>
  54. <HEAD>
  55.  
  56. <!SCRIPT RUNAT=SERVER LANGUAGE=JSCRIPT>
  57.  
  58.     test = new MSDBConnection("test", "ODBC","MS Access", "Northwind","admin","",false);
  59.     if (test.connect()) Response.write("The Database connected properly<BR>")
  60.         else Response.write ("The database did not connect<BR>");
  61.    
  62.     if (database.connect()) write ("The Database is connected<BR>")
  63.         else Response.write ("The Database is not connected<BR>");
  64.    
  65.     write ("The Database is being disconnected<BR>");   
  66.     dbResult = test.emitProperties();
  67.     test.render();
  68.  
  69.     dbResult = test.disconnect();
  70.     Response.write ("The database is now disconnected: <B>" + dbResult + "</B><BR>");
  71.  
  72. <!/SCRIPT>
  73.  
  74. </HEAD>
  75. <BODY>
  76. <%
  77.    // This is only necessary if the component will be used with other components
  78.    MSDBConnection1.render()  
  79. %>
  80.  
  81. </BODY>
  82. </HTML>
  83.  
  84. =====================================================================*/
  85. function MSDBConnection(name,
  86.                         databaseType,
  87.                         ODBCDatabaseType,
  88.                         databaseServer,
  89.                         userName,
  90.                         password,
  91.                         globalConn) 
  92. { 
  93.     // Properties
  94.    this.databaseType      = "ODBC";    // All ASP connections are via ODBC
  95.    this.ODBCDatabaseType  = ODBCDatabaseType;
  96.    this.databaseServer    = databaseServer;
  97.    this.userName          = userName;
  98.    this.password          = password;
  99.    this.globalConn        = globalConn;
  100.    this.connection          = null;
  101.    this.name              = name;    
  102.    Session(this.name)      = null;
  103.     
  104.    // Methods
  105.    this.connect = dbConnect;
  106.    this.disconnect = dbDisconnect;
  107.    this.connected = dbConnected;
  108.    this.render = dbRender;
  109.    this.emitProperties = dbEmitProperties;
  110.    
  111.    // Global connect commands removed because done in Global.asa file
  112.    // Set Application("globalConn") here too
  113.    Application("globalConn") = globalConn;
  114.  
  115.    // Write out to session object for use by Query component 
  116.    Session("databaseType") = this.databaseType;
  117.    Session("ODBCDatabaseType") = this.ODBCDatabaseType;
  118.  
  119. } //End MSDBConnection 
  120.  
  121.  
  122.  
  123. // Method - dbConnect()
  124. // Attempts to make a connection to the database using the Database Object, if the database is not already
  125. // connected. If the database is already connected, the method returns true.
  126.  
  127. function dbConnect ()
  128. {
  129.    if (!this.connected())
  130.    {
  131.         var connection = new Object();
  132.         connection = Server.CreateObject("ADODB.Connection");
  133.         connection.Open(this.databaseServer, this.userName, this.password);
  134.  
  135.        //if (ConnectionErrors(connection) == 1) {
  136.            // Store connection object in Session object for reference by DBQuery component
  137.            Session(this.name) = null;
  138.            Session(this.name) = connection;
  139.             return true;
  140.       //}
  141.       //else
  142.             //return false;
  143.     } // end if (!this.connected())
  144.     
  145.    else return true;   
  146. }   //End dbConnect;
  147.  
  148.  
  149. // Method - dbDisconnect
  150. // Attempts to disconnect the Database if it's connected. Otherwise returns a true result if the database is already
  151. // disconnected.
  152.  
  153. function dbDisconnect ()
  154. {
  155.    if (this.connected())
  156.    Session(this.name).Close();
  157.    return true;
  158. }   //End dbDisconnect
  159.  
  160. // Method - dbConnected
  161. // Attempts to determine the state of the connection. If the connection exists then this function returns true.
  162. // Otherwise, false is returned.
  163.  
  164. function dbConnected ()
  165. {
  166.     if (Session(this.name) != null)
  167.         //{
  168.         // ConnectionErrors() is a VBScript function that checks the connection object's errors collection.
  169.         // This is a workaround for not being able to reference ADO connection objects' errors collections
  170.         // from within JScript functions.
  171.         //if (ConnectionErrors(Session(this.name)) == 1)
  172.             return true;
  173.         //else
  174.             //return false;
  175.         //}
  176.     else
  177.         return false;
  178. }   //End dbConnected
  179.  
  180. // Method - dbEmitProperties()
  181. // emits all the object's properties.  Used as a debuging tool to verify correct
  182. // manipulation of the object.
  183.  
  184. function dbEmitProperties ()
  185. {
  186.       //debug("Writing MSDBConnection properties...");
  187.       write("\n<BR><B>ASPDBConnection Properties:</B>");
  188.       write("\n<BR>databaseType = " + this.databaseType);
  189.       write("\n<BR>ODBCDatabaseType = " + this.ODBCDatabaseType);
  190.       write("\n<BR>databaseServer = " + this.databaseServer);
  191.       write("\n<BR>userName = " + this.userName);
  192.       write("\n<BR>password = " + this.password);
  193.       write("\n<BR>globalConn = " + this.globalConn);
  194.       write("<BR>");
  195.       return true;
  196.  }   //End dbEmitProperties;
  197.  
  198. // Method - dbRender
  199. // This method outputs the hidden fields that contain the values of the database
  200. // connection parameters. This is used by the form handler that corresponds to the
  201. // UpdateTable component.
  202.  
  203. function dbRender ()
  204. {
  205.   // Output the hidden fields for use by Update component
  206.    var pre = "amaspHidden_" + this.name + "_";
  207.    write("\r\n<INPUT NAME = \"" + pre + "ODBCDatabaseType\" VALUE = \"" + this.ODBCDatabaseType + "\" TYPE = \"HIDDEN\">");
  208.    write("\r\n<INPUT NAME = \"" + pre + "databaseType\" VALUE = \"" + this.databaseType + "\" TYPE = \"HIDDEN\">");
  209.    write("\r\n<INPUT NAME = \"" + pre + "databaseServer\" VALUE = \"" + this.databaseServer + "\" TYPE = \"HIDDEN\">");
  210.    write("\r\n<INPUT NAME = \"" + pre + "userName\" VALUE = \"" + this.userName + "\" TYPE = \"HIDDEN\">");
  211.    write("\r\n<INPUT NAME = \"" + pre + "password\" VALUE = \"" + this.password + "\" TYPE = \"HIDDEN\">");
  212.    write("\r\n<INPUT NAME = \"" + pre + "globalConn\" VALUE = \"" + this.globalConn + "\" TYPE = \"HIDDEN\">");
  213.   
  214.  
  215. }   //End dbRender
  216. </SCRIPT>