Initial commit.

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "libraries/oop"]
+	path = libraries/oop
+	url = https://git.ad5001.eu/Ad5001/BashOOP

Docker.shn

@@ -0,0 +1,33 @@
+#
+# DockerBashOOP - Implementation of BashOOP for Docker.
+# Copyright (C) 2021  Ad5001 <mail@ad5001.eu>
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+namespace Docker
+
+createPropertyHolder Docker
+
+property Docker.RequiresSudo true 
+# NOTE: here we use it's declared as a string, because bash booleans using the true and false commands use exit codes,
+#       which requires to use more than one line to declare, thus add unnecessary complexity to the code.
+property Docker.Executable "$(which docker)"
+# This property is overridable for custom locations of the docker executable.
+
+static_class Utils "Utils.shc"
+
+class RunningContainer "RunningContainer.shc"
+
+class Image "Image.shc"

LICENSE.md

@@ -0,0 +1,157 @@
+### GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+<https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the
+terms and conditions of version 3 of the GNU General Public License,
+supplemented by the additional permissions listed below.
+
+#### 0. Additional Definitions.
+
+As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the
+GNU General Public License.
+
+"The Library" refers to a covered work governed by this License, other
+than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+#### 1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+#### 2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+-   a) under this License, provided that you make a good faith effort
+    to ensure that, in the event an Application does not supply the
+    function or data, the facility still operates, and performs
+    whatever part of its purpose remains meaningful, or
+-   b) under the GNU GPL, with none of the additional permissions of
+    this License applicable to that copy.
+
+#### 3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a
+header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+-   a) Give prominent notice with each copy of the object code that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the object code with a copy of the GNU GPL and this
+    license document.
+
+#### 4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken
+together, effectively do not restrict modification of the portions of
+the Library contained in the Combined Work and reverse engineering for
+debugging such modifications, if you also do each of the following:
+
+-   a) Give prominent notice with each copy of the Combined Work that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the Combined Work with a copy of the GNU GPL and this
+    license document.
+-   c) For a Combined Work that displays copyright notices during
+    execution, include the copyright notice for the Library among
+    these notices, as well as a reference directing the user to the
+    copies of the GNU GPL and this license document.
+-   d) Do one of the following:
+    -   0) Convey the Minimal Corresponding Source under the terms of
+        this License, and the Corresponding Application Code in a form
+        suitable for, and under terms that permit, the user to
+        recombine or relink the Application with a modified version of
+        the Linked Version to produce a modified Combined Work, in the
+        manner specified by section 6 of the GNU GPL for conveying
+        Corresponding Source.
+    -   1) Use a suitable shared library mechanism for linking with
+        the Library. A suitable mechanism is one that (a) uses at run
+        time a copy of the Library already present on the user's
+        computer system, and (b) will operate properly with a modified
+        version of the Library that is interface-compatible with the
+        Linked Version.
+-   e) Provide Installation Information, but only if you would
+    otherwise be required to provide such information under section 6
+    of the GNU GPL, and only to the extent that such information is
+    necessary to install and execute a modified version of the
+    Combined Work produced by recombining or relinking the Application
+    with a modified version of the Linked Version. (If you use option
+    4d0, the Installation Information must accompany the Minimal
+    Corresponding Source and Corresponding Application Code. If you
+    use option 4d1, you must provide the Installation Information in
+    the manner specified by section 6 of the GNU GPL for conveying
+    Corresponding Source.)
+
+#### 5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library
+side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+-   a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities, conveyed under the terms of this License.
+-   b) Give prominent notice with the combined library that part of it
+    is a work based on the Library, and explaining where to find the
+    accompanying uncombined form of the same work.
+
+#### 6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+as you received it specifies that a certain numbered version of the
+GNU Lesser General Public License "or any later version" applies to
+it, you have the option of following the terms and conditions either
+of that published version or of any later version published by the
+Free Software Foundation. If the Library as you received it does not
+specify a version number of the GNU Lesser General Public License, you
+may choose any version of the GNU Lesser General Public License ever
+published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

RunningContainer.shc

@@ -0,0 +1,83 @@
+#
+# DockerBashOOP - Implementation of BashOOP for Docker.
+# Copyright (C) 2021  Ad5001 <mail@ad5001.eu>
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+property RunningContainer.found
+property RunningContainer.id
+property RunningContainer.image
+property RunningContainer.created
+property RunningContainer.status
+property RunningContainer.ports
+property RunningContainer.name
+
+# Constructor to fetch a running container.
+# First argument is what to fetch, and second is matching attribute.
+# Example of first arguments: "named" to find by name, "created" to find by creation date, 
+# "withid" to find by container id, "withimage" to find by image, "withstatus" to check status, "withport" to find all having this port forwarded....
+# NOTE: Multiple containers can be matched. If so, all properties contain the value for each container per line.
+# NOTE: If no container is found, a message will be printed, and the constructor will exit with false.
+# Signature: (<string matchType>, <string matchValue>)
+RunningContainer.constructor() {
+    matchType=$1
+    matchValue=$2
+    lines=""
+    case $matchType in
+        withid)
+            lines="$(RunningContainer.findLineByValue 1 == $matchValue)"
+            ;;
+        withimage)
+            lines="$(RunningContainer.findLineByValue 2 == $matchValue)"
+            ;;
+        created)
+            lines="$(RunningContainer.findLineByValue 4 == $matchValue)"
+            ;;
+        withstatus)
+            lines="$(RunningContainer.findLineByValue 5 == $matchValue)"
+            ;;
+        withport)
+            lines="$(RunningContainer.findLineByValue 6 ~ $matchValue)"
+            ;;
+        named)
+            lines="$(RunningContainer.findLineByValue 7 == $matchValue)"
+            if [ -z "$lines" ]; then # Sometimes, when no ports are forwarded, the name is in the 6th field.
+                lines="$(RunningContainer.findLineByValue 6 == $matchValue)"
+            fi
+            ;;
+    esac
+    if [ ! -z $lines ]; then
+        this.found = true
+        this.id = "$(echo $lines | awk -F " {2,}" '{ print $1 }')"
+        this.image = "$(echo $lines | awk -F " {2,}" '{ print $2 }')"
+        this.created = "$(echo $lines | awk -F " {2,}" '{ print $4 }')"
+        this.status = "$(echo $lines | awk -F " {2,}" '{ print $5 }')"
+        this.ports = "$(echo $lines | awk -F " {2,}" '{ print $6 }')"
+        this.name = "$(echo $lines | awk -F " {2,}" '{ print $7 }')"
+    else
+        this.found = false
+    fi
+}
+
+# Finds all containers in "docker ps" with a certain field matching a value and returns their lines.
+# Signature: (<int fieldId>, <string operation>, <string fieldValue>)
+RunningContainer.findLineByValue() {
+    fieldId=$1
+    operation=$2
+    fieldValue=$3
+    docker ps | awk -F " {2,}" -v value="$fieldValue" 'NR>1 && $'"$fieldId"' '"$operation"' value'
+}
+
+

Utils.shc

@@ -0,0 +1,37 @@
+#
+# DockerBashOOP - Implementation of BashOOP for Docker.
+# Copyright (C) 2021  Ad5001 <mail@ad5001.eu>
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+# This class contains various utils required for Docker.
+
+# Returns the base command for docker, with it's executable and sudo if necessary.
+# Returns string.
+Utils.DockerCommand() { 
+    if [ $(Docker.RequiresSudo) == true ]; then echo -n "sudo "; fi
+    echo "$(Docker.Executable)"
+}
+
+# Checks if the user has permission to use docker.
+# Retuns bool.
+Utils.hasPermission() {
+    $(Utils.DockerCommand) ps 2>&1 | grep -q "permission denied"
+    # Check status of last command. If permission denied is found, then we do not have permission to use docker.
+    if [ $? ]; then echo false; else echo true; fi
+}
+
+
+

libraries/oop

@@ -0,0 +1 @@
+Subproject commit ba000379d7f736f5ad27a609588e555fe94361d0