Include source in the npm package for users with no GitHub access

Author: cjbj

INSTALL.md

@@ -1292,29 +1292,28 @@ installing.
 
 ### <a name="offline"></a> 3.12 Node-oracledb Installation Without Internet Access
 
-There are two ways to install node-oracledb on computers that do not
-have internet access or do not have access to the [npm registry][4].
-You can either do a normal install on another machine, or manually
-extract the node-oracledb packages.
+There are several ways to install node-oracledb on computers that do
+not have internet access, or have no access to either the [npm
+registry][4] or [github.com][1].
 
-#### 3.12.1 Normal Install on an Intermediary Machine
+#### 3.12.1 Installing on an Intermediary Machine
 
-On an identical machine that does have access, install node-oracle
-following the [Node-oracledb Installation Instructions](#instructions)
-for that operating system.
+On an identical machine that has access to the internet, install
+node-oracle following the [Node-oracledb Installation
+Instructions](#instructions) for that operating system.
 
 Then copy `node_modules/oracledb` and Oracle client libraries to the
 offline computer.  Windows users should see [Copying node-oracledb
 Binaries on Windows](#winbins) and make sure the correct Visual Studio
 Redistributable is also installed.
 
-#### 3.12.2 Manual Install Using Pre-built Binaries
+#### 3.12.2 Manually Extracting Pre-built Binaries
 
 If pre-built node-oracledb binaries are available for your version
 of Node.js and operating system, you can install manually:
 
-- On a computer that has internet access, navigate to a release on the
-  [GitHub Release][41] page.
+- On a computer that has access to github.com, navigate to a release
+  on the [GitHub Release][41] page.
 
   Download the release's main node-oracledb package, for example
   `oracledb-2.0.15.tgz`.
@@ -1354,21 +1353,25 @@ of Node.js and operating system, you can install manually:
        |-- CHANGELOG.md
        |-- LICENSE.md
        |-- README.md
+       |-- binding.gyp
        |-- index.js
        |-- lib
-       |-- |-- connection.js
-       |-- |-- lob.js
-       |-- |-- oracledb.js
-       |-- |-- pool.js
-       |-- |-- querystream.js
-       |-- |-- resultset.js
-       |-- |-- util.js
-       |-- oracledb-2.0.15.tgz
+       |   |-- connection.js
+       |   |-- lob.js
+       |   |-- oracledb.js
+       |   |-- pool.js
+       |   |-- querystream.js
+       |   |-- resultset.js
+       |   |-- util.js
+       |-- odpi
+       |   |-- . . .
        |-- package
-       |-- |-- extractpackage.js
-       |-- |-- oracledbinstall.js
-       |-- |-- util.js
+       |   |-- extractpackage.js
+       |   |-- oracledbinstall.js
+       |   |-- util.js
        |-- package.json
+       |-- src
+           |-- . . .
   ```
 
 - Locate `node_modules/oracledb/package/extractpackage.js` and use it
@@ -1387,6 +1390,57 @@ of Node.js and operating system, you can install manually:
   Binaries on Windows](#winbins) and make sure the correct Visual
   Studio Redistributable is also installed.
 
+#### 3.12.3 Installing node-oracledb without GitHub Access
+
+Some companies block access to github.com so `npm install oracledb`
+will fail to download binaries, as will installing source code from
+GitHub with `npm install oracle/node-oracledb.git#v2.0.15`.
+
+
+To install node-oracledb in this case, compile the source code
+included in the npm package:
+
+- Use `npm install -verbose oracledb` and locate the URL it uses to
+  download the node-oracledb package, for example
+  `https://registry.npmjs.org/oracledb/-/oracledb-2.0.15.tgz`
+
+  Download and save the package.
+
+- Create a directory such as `oracledb_build` and extract the package
+  inside it:
+
+  ```
+  mkdir oracledb_build
+  mv oracledb-2.0.15.tgz oracledb_build
+  cd oracledb_build
+  tar -xzf oracledb-2.0.15.tgz
+  ```
+
+  The directory contents will be the same as shown in the previous
+  section.
+
+- Edit `package.json` and delete the line that invokes the binary
+  download script:
+
+  ```
+  "install": "node package/oracledbinstall.js",
+  ```
+
+- Either add a dependency on [nan](https://www.npmjs.com/package/nan)
+  to `package.json`, or manually install it:
+
+  ```
+  npm install nan
+  ```
+
+- Install the build prerequisites for compilation, following the
+  [Node-oracledb Installation Instructions](#instructions).
+
+- Build node-oracledb from outside the directory:
+
+  ```
+  npm install ./oracledb_build
+  ```
 
 ## <a name="installingv1"></a> 4. Installing Node-oracledb 1.x
 
@@ -1398,6 +1452,8 @@ add-on you must explictly use its version when installing:
 npm install [email protected]
 ```
 
+This version always requires compilation.
+
 ## <a name="otherresources"></a> 5. Useful Resources for Node-oracledb
 
 Node-oracledb can be installed on the pre-built [*Database App

package/Makefile

@@ -28,9 +28,10 @@ GIT=git
 NODE=node
 NPM=npm
 
-GITSHA=$(shell $(GIT) rev-parse --short HEAD)
+GITSHA=$(shell $(GIT) rev-parse HEAD)
+SUBMOD=$(shell $(CD) ../odpi && $(GIT) rev-parse HEAD)
+NODEVER=$(shell $(NODE) --version)
 BUILDDATE=$(shell $(DATE))
-SUBMOD="$(shell $(CD) .. && $(GIT) submodule)"  # Old git needs to run this in toplevel
 
 # createpackage.js assumes these paths
 BINARY_PATH_LOCAL=../build/Release/oracledb.node
@@ -58,8 +59,10 @@ endif
 # invokes oracledbinstall.js at install time
 npmpackage:
 	@$(RMDIR) $(TMPDIR)
-	$(MKDIR) -m 755 $(TMPDIR) && $(CP) ./package.json ../index.js ../README.md $(LICENSE_PATH_LOCAL) ../CHANGELOG.md $(TMPDIR) && (echo "NJS SHA: $(GITSHA)" && echo "Package date: $(BUILDDATE)" ) >> $(TMPDIR)/LICENSE.md
-	$(MKDIR) -m 755 $(TMPDIR)/lib && $(CP) ../lib/*.js $(TMPDIR)/lib
+	$(MKDIR) -m 755 $(TMPDIR) && $(CP) ./package.json ../index.js ../README.md $(LICENSE_PATH_LOCAL) ../CHANGELOG.md ../binding.gyp $(TMPDIR)
+	$(MKDIR) -m 755 $(TMPDIR)/lib && $(CP) ../lib/*.js $(TMPDIR)/lib && $(ECHO) "$(GITSHA) $(BUILDDATE)" > $(TMPDIR)/lib/rel.txt
+	$(MKDIR) -m 755 $(TMPDIR)/src && $(CP) ../src/* $(TMPDIR)/src
+	$(MKDIR) -m 755 $(TMPDIR)/odpi && $(MKDIR) -m 755 $(TMPDIR)/odpi/src && $(MKDIR) -m 755 $(TMPDIR)/odpi/include && $(CP) ../odpi/src/* $(TMPDIR)/odpi/src && $(CP) ../odpi/include/* $(TMPDIR)/odpi/include
 	$(MKDIR) -m 755 $(TMPDIR)/package && $(CP) oracledbinstall.js extractpackage.js util.js $(TMPDIR)/package
 	($(CD) $(TMPDIR) && $(TAR) -czf ../oracledb-$(VER).tgz ./*)
 	@$(ECHO) "==> Created generic npm production package for node-oracledb $(VER)"
@@ -73,7 +76,8 @@ npmpackage:
 # Create a package containing (i) the license file and (ii) the
 # node-oracledb binary for the current environment
 binarypackage: $(BINARY_PATH_LOCAL) $(LICENSE_PATH_LOCAL)
-	$(CP) $(LICENSE_PATH_LOCAL) $(LICENSE_PATH_LOCAL).bk && (echo "NJS SHA: $(GITSHA)" && echo $(SUBMOD) && echo "Package date: $(BUILDDATE)") >> $(LICENSE_PATH_LOCAL)
+	$(GIT) checkout $(LICENSE_PATH_LOCAL)
+	$(CP) $(LICENSE_PATH_LOCAL) $(LICENSE_PATH_LOCAL).bk && $(ECHO) "$(GITSHA) $(SUBMOD) $(NODEVER) $(BUILDDATE)" >> $(LICENSE_PATH_LOCAL)
 	$(NODE) createpackage.js
 	$(MV) $(LICENSE_PATH_LOCAL).bk $(LICENSE_PATH_LOCAL)
 	@$(ECHO) "==> Created binary package for Node.js `$(NODE) --version`"

package/oracledbinstall.js

@@ -317,6 +317,7 @@ function installBinary() {
       .then(compressedReadstream => {
         return packageUtil.extract({
           licenseDest: packageUtil.LICENSE_PATH_LOCAL,
+          writeLicense: true,
           binaryDest: packageUtil.BINARY_PATH_LOCAL,
           compressedReadstream: compressedReadstream
         });