Compare commits

..

1 Commits

Author SHA1 Message Date
dependabot[bot] 8170ac6b56
Merge 354105b047 into 8bf26a334c 2023-07-23 02:07:50 +02:00
9 changed files with 56 additions and 909 deletions

View File

@ -13,11 +13,11 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Set up Go
uses: actions/setup-go@v4
uses: actions/setup-go@v3
with:
go-version: '1.20.2'
go-version: ^1.15
- name: Check out code
uses: actions/checkout@v4
uses: actions/checkout@v3
- name: Build
run: make build
- name: Test

View File

@ -1,9 +1,11 @@
FROM golang:1.20.2
FROM golang:latest
WORKDIR /app
COPY ./ /app
RUN go install github.com/githubnemo/CompileDaemon@latest
RUN go mod download
ENTRYPOINT CompileDaemon --build="make build" --command=./bin/edgeboxctl-$(go env GOOS)-$(go env GOARCH)
RUN go get github.com/githubnemo/CompileDaemon
ENTRYPOINT CompileDaemon --build="make build" --command=./bin/edgeboxctl

View File

@ -1,13 +1,9 @@
.DEFAULT_GOAL := build
PROJECT?=github.com/edgebox-iot/edgeboxctl
PROJECT ?= github.com/edgebox-iot/edgeboxctl
RELEASE ?= dev
COMMIT := $(shell git rev-parse --short HEAD)
BUILD_DATE := $(shell date -u '+%Y-%m-%d_%H:%M:%S')
BUILD_DIR = bin
GOOS := $(shell go env GOOS)
GOARCH := $(shell go env GOARCH)
build-all:
GOOS=linux GOARCH=amd64 make build
@ -25,10 +21,6 @@ build-arm64:
build-armhf:
GOOS=linux GOARCH=arm RELEASE=prod make build
build-amd64:
GOOS=linux GOARCH=amd64 RELEASE=prod make build
build:
@echo "Building ${GOOS}-${GOARCH}"
GOOS=${GOOS} GOARCH=${GOARCH} go build \
@ -36,6 +28,7 @@ build:
-X ${PROJECT}/internal/diagnostics.Commit=${COMMIT} \
-X ${PROJECT}/internal/diagnostics.BuildDate=${BUILD_DATE}" \
-o bin/edgeboxctl-${GOOS}-${GOARCH} ${PROJECT}/cmd/edgeboxctl
cp ./bin/edgeboxctl-${GOOS}-${GOARCH} ./bin/edgeboxctl
clean:
rm -rf ${BUILD_DIR}
@ -48,10 +41,9 @@ test-with-coverage:
go test -tags=unit -timeout=600s -v ./... -coverprofile=coverage.out
install:
sudo systemctl stop edgeboxctl || true
sudo rm -rf /usr/local/bin/edgeboxctl /usr/local/sbin/edgeboctl /lib/systemd/system/edgeboxctl.service
sudo cp ./bin/edgeboxctl-${GOOS}-${GOARCH} /usr/local/bin/edgeboxctl
sudo cp ./bin/edgeboxctl-${GOOS}-${GOARCH} /usr/local/sbin/edgeboxctl
sudo systemctl stop edgeboxctl
sudo rm -rf /usr/local/bin/edgeboxctl /lib/systemd/system/edgeboxctl.service
sudo cp ./bin/edgeboxctl /usr/local/bin/edgeboxctl
sudo cp ./edgeboxctl.service /lib/systemd/system/edgeboxctl.service
sudo systemctl daemon-reload
@echo "Edgeboxctl installed successfully"
@ -61,7 +53,6 @@ install-prod: build-prod install
install-cloud: build-cloud install
install-arm64: build-arm64 install
install-armhf: build-armhf install
install-amd64: build-amd64 install
start:
systemctl start edgeboxctl
@ -69,8 +60,6 @@ start:
stop:
systemctl stop edgeboxctl
status:
systemctl status edgeboxctl
log: start
journalctl -fu edgeboxctl

View File

@ -8,7 +8,7 @@
<h3 align="center">Edgebox Control Module</h3>
<p align="center">
A System Control module written in Go. Its responsibility is to configure dependencies and perform system tasks, automatically on a schedule, or on demand.
A System Control module written in Go. Its resonsability is to configure dependencies and perform system tasks, automatically in a schedule, or by command.
<br />
<br />
<a href="https://github.com/github_username/edgeboxctl/issues">Report Bug</a>
@ -38,6 +38,8 @@
<!-- ABOUT THE PROJECT -->
## About The Project
[![Edgebox Screen Shot][product-screenshot]](https://edgebox.co)
Edgebox is an easy to configure and use system. It brings powerful features that go alongside or can even completely replace various services that you already use in the day-to-day.
@ -56,15 +58,18 @@ To get a local copy up and running follow these simple steps.
### Prerequisites
If you're running for development purposes, a docker container suffices, so make sure you have:
If you're installing this to run natively in the system, you better be doing it inside of the [Development Virtual Machine](https://github.com/edgebox-iot/devm). This software can do destructive action in the system is is running. You've been warned.
* docker
* docker compose
If you're running for development purposes, a Docker container suffices, so make sure you have:
* Docker
* Docker Compose
```sh
sudo apt-get install docker docker-compose
```
Check the following links for more info on [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/).
Aditionally, `edgeboxctl` needs the following bash commands available wherever it runs:
Aditionally, edgeboxctl needs the following bash commands available wherever it runs:
* `arm-linux-gnueabi-gcc` (`sudo apt-get install gcc-arm*`)
* `sh`
* `rm`
@ -116,4 +121,4 @@ Contributions are what make the open source community such an amazing place to b
<!-- LICENSE -->
## License
Distributed under the Elastic License 2.0. See `LICENSE` for more information.
Distributed under the MIT License. See `LICENSE` for more information.

View File

@ -6,12 +6,11 @@ import (
"os"
"strings"
"time"
"github.com/joho/godotenv"
"github.com/edgebox-iot/edgeboxctl/internal/system"
"github.com/edgebox-iot/edgeboxctl/internal/utils"
"github.com/edgebox-iot/edgeboxctl/internal/diagnostics"
)
// EdgeApp : Struct representing an EdgeApp in the system
@ -19,15 +18,11 @@ type EdgeApp struct {
ID string `json:"id"`
Name string `json:"name"`
Description string `json:"description"`
Experimental bool `json:"experimental"`
Status EdgeAppStatus `json:"status"`
Services []EdgeAppService `json:"services"`
InternetAccessible bool `json:"internet_accessible"`
NetworkURL string `json:"network_url"`
InternetURL string `json:"internet_url"`
Options []EdgeAppOption `json:"options"`
NeedsConfig bool `json:"needs_config"`
Login EdgeAppLogin `json:"login"`
}
// MaybeEdgeApp : Boolean flag for validation of edgeapp existance
@ -48,30 +43,9 @@ type EdgeAppService struct {
IsRunning bool `json:"is_running"`
}
type EdgeAppOption struct {
Key string `json:"key"`
Value string `json:"value"`
DefaultValue string `json:"default_value"`
Format string `json:"format"`
Description string `json:"description"`
IsSecret bool `json:"is_secret"`
IsInstallLocked bool `json:"is_install_locked"`
}
type EdgeAppLogin struct {
Enabled bool `json:"enabled"`
Username string `json:"username"`
Password string `json:"password"`
}
const configFilename = "/edgebox-compose.yml"
const envFilename = "/edgebox.env"
const optionsTemplateFilename = "/edgeapp.template.env"
const optionsEnvFilename = "/edgeapp.env"
const authEnvFilename = "/auth.env"
const runnableFilename = "/.run"
const appdataFoldername = "/appdata"
const postInstallFilename = "/edgebox-postinstall.done"
const myEdgeAppServiceEnvFilename = "/myedgeapp.env"
const defaultContainerOperationSleepTime time.Duration = time.Second * 10
@ -89,8 +63,6 @@ func GetEdgeApp(ID string) MaybeEdgeApp {
edgeAppName := ID
edgeAppDescription := ""
edgeAppExperimental := false
edgeAppOptions := []EdgeAppOption{}
edgeAppEnv, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + ID + envFilename)
@ -103,108 +75,8 @@ func GetEdgeApp(ID string) MaybeEdgeApp {
if edgeAppEnv["EDGEAPP_DESCRIPTION"] != "" {
edgeAppDescription = edgeAppEnv["EDGEAPP_DESCRIPTION"]
}
if edgeAppEnv["EDGEAPP_EXPERIMENTAL"] == "true" {
edgeAppExperimental = true
}
}
needsConfig := false
hasFilledOptions := false
edgeAppOptionsTemplate, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + ID + optionsTemplateFilename)
if err != nil {
log.Println("Error loading options template file for edgeapp " + edgeAppName)
} else {
// Try to read the edgeAppOptionsEnv file
edgeAppOptionsEnv, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + ID + optionsEnvFilename)
if err != nil {
log.Println("Error loading options env file for edgeapp " + edgeAppName)
} else {
hasFilledOptions = true
}
for key, value := range edgeAppOptionsTemplate {
optionFilledValue := ""
if hasFilledOptions {
// Check if key exists in edgeAppOptionsEnv
optionFilledValue = edgeAppOptionsEnv[key]
}
format := ""
defaultValue := ""
description := ""
installLocked := false
// Parse value to separate by | and get the format, installLocked, description and default value
// Format is the first element
// InstallLocked is the second element
// Description is the third element
// Default value is the fourth element
valueSlices := strings.Split(value, "|")
if len(valueSlices) > 0 {
format = valueSlices[0]
}
if len(valueSlices) > 1 {
installLocked = valueSlices[1] == "true"
}
if len(valueSlices) > 2 {
description = valueSlices[2]
}
if len(valueSlices) > 3 {
defaultValue = valueSlices[3]
}
// // If value contains ">|", then get everything that is to the right of it as the description
// // and get everything between "<>" as the format
// if strings.Contains(value, ">|") {
// description = strings.Split(value, ">|")[1]
// // Check if description has default value. That would be everything that is to the right of the last "|"
// if strings.Contains(description, "|") {
// defaultValue = strings.Split(description, "|")[1]
// description = strings.Split(description, "|")[0]
// }
// value = strings.Split(value, ">|")[0]
// // Remove the initial < from value
// value = strings.TrimPrefix(value, "<")
// } else {
// // Trim initial < and final > from value
// value = strings.TrimPrefix(value, "<")
// value = strings.TrimSuffix(value, ">")
// }
isSecret := false
// Check if the lowercased key string contains the letters "pass", "secret", "key"
lowercaseKey := strings.ToLower(key)
// check if lowercaseInput contains "pass", "key", or "secret", or "token"
if strings.Contains(lowercaseKey, "pass") ||
strings.Contains(lowercaseKey, "key") ||
strings.Contains(lowercaseKey, "secret") ||
strings.Contains(lowercaseKey, "token") {
isSecret = true
}
currentOption := EdgeAppOption{
Key: key,
Value: optionFilledValue,
DefaultValue: defaultValue,
Description: description,
Format: format,
IsSecret: isSecret,
IsInstallLocked: installLocked,
}
edgeAppOptions = append(edgeAppOptions, currentOption)
if optionFilledValue == "" {
needsConfig = true
}
}
}
edgeAppInternetAccessible := false
edgeAppInternetURL := ""
@ -218,36 +90,16 @@ func GetEdgeApp(ID string) MaybeEdgeApp {
}
}
edgeAppBasicAuthEnabled := false
edgeAppBasicAuthUsername := ""
edgeAppBasicAuthPassword := ""
edgeAppAuthEnv, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + ID + authEnvFilename)
if err != nil {
log.Println("No auth.env file found. Login status is disabled.")
} else {
if edgeAppAuthEnv["USERNAME"] != "" && edgeAppAuthEnv["PASSWORD"] != "" {
edgeAppBasicAuthEnabled = true
edgeAppBasicAuthUsername = edgeAppAuthEnv["USERNAME"]
edgeAppBasicAuthPassword = edgeAppAuthEnv["PASSWORD"]
}
}
result = MaybeEdgeApp{
EdgeApp: EdgeApp{
ID: ID,
Name: edgeAppName,
Description: edgeAppDescription,
Experimental: edgeAppExperimental,
Status: GetEdgeAppStatus(ID),
Services: GetEdgeAppServices(ID),
InternetAccessible: edgeAppInternetAccessible,
NetworkURL: ID + "." + system.GetHostname() + ".local",
NetworkURL: ID + system.GetHostname() + ".local",
InternetURL: edgeAppInternetURL,
Options: edgeAppOptions,
NeedsConfig: needsConfig,
Login: EdgeAppLogin{edgeAppBasicAuthEnabled, edgeAppBasicAuthUsername, edgeAppBasicAuthPassword},
},
Valid: true,
}
@ -271,54 +123,22 @@ func IsEdgeAppInstalled(ID string) bool {
}
func writeAppRunnableFiles(ID string) bool {
edgeAppPath := utils.GetPath(utils.EdgeAppsPath)
_, err := os.Stat(edgeAppPath + ID + runnableFilename)
if os.IsNotExist(err) {
_, err := os.Create(edgeAppPath + ID + runnableFilename)
if err != nil {
log.Fatal("Runnable file for EdgeApp could not be created!")
return false
}
// Check the block default apps option
blockDefaultAppsOption := utils.ReadOption("DASHBOARD_BLOCK_DEFAULT_APPS_PUBLIC_ACCESS")
if blockDefaultAppsOption != "yes" {
// Create myedgeapp.env file with default network URL
envFilePath := edgeAppPath + ID + myEdgeAppServiceEnvFilename
var networkURL string
domainName := utils.ReadOption("DOMAIN_NAME")
if domainName != "" {
networkURL = ID + "." + domainName
} else if diagnostics.GetReleaseVersion() == diagnostics.CLOUD_VERSION {
cluster := utils.ReadOption("CLUSTER")
username := utils.ReadOption("USERNAME")
if cluster != "" && username != "" {
networkURL = username + "-" + ID + "." + cluster
}
} else {
networkURL = ID + "." + system.GetHostname() + ".local" // default
}
env, _ := godotenv.Unmarshal("INTERNET_URL=" + networkURL)
err = godotenv.Write(env, envFilePath)
if err != nil {
log.Printf("Error creating myedgeapp.env file: %s", err)
// result = false
}
}
}
return true
}
func SetEdgeAppInstalled(ID string) bool {
result := true
edgeAppPath := utils.GetPath(utils.EdgeAppsPath)
_, err := os.Stat(edgeAppPath + ID + runnableFilename)
if os.IsNotExist(err) {
_, err := os.Create(edgeAppPath + ID + runnableFilename)
result = true
if err != nil {
log.Fatal("Runnable file for EdgeApp could not be created!")
result = false
}
if writeAppRunnableFiles(ID) {
buildFrameworkContainers()
} else {
@ -332,63 +152,13 @@ func SetEdgeAppInstalled(ID string) bool {
}
func SetEdgeAppBulkInstalled(IDs []string) bool {
result := true
for _, ID := range IDs {
writeAppRunnableFiles(ID)
}
buildFrameworkContainers()
return result
}
func SetEdgeAppNotInstalled(ID string) bool {
// Stop the app first
StopEdgeApp(ID)
// Now remove any files
result := true
err := os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + runnableFilename)
if err != nil {
result = false
log.Println(err)
}
err = os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + authEnvFilename)
if err != nil {
result = false
log.Println(err)
}
err = os.RemoveAll(utils.GetPath(utils.EdgeAppsPath) + ID + appdataFoldername)
if err != nil {
result = false
log.Println(err)
}
err = os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + myEdgeAppServiceEnvFilename)
if err != nil {
result = false
log.Println(err)
}
err = os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + optionsEnvFilename)
if err != nil {
result = false
log.Println(err)
}
err = os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + postInstallFilename)
if err != nil {
result = false
log.Println(err)
log.Fatal(err)
}
buildFrameworkContainers()
@ -477,24 +247,12 @@ func GetEdgeAppServices(ID string) []EdgeAppService {
var edgeAppServices []EdgeAppService
for _, serviceID := range serviceSlices {
shouldBeRunning := false
cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "exec", "-T", serviceID, "echo", "'Service Check'"}
cmdResult := utils.Exec(wsPath, "docker-compose", cmdArgs)
isRunning := false
// Is service "runnable" when .run lockfile in the app folder
_, err := os.Stat(utils.GetPath(utils.EdgeAppsPath) + ID + runnableFilename)
if !os.IsNotExist(err) {
shouldBeRunning = true
if cmdResult != "" {
isRunning = true
}
// Check if the service is actually running
if shouldBeRunning {
cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "exec", "-T", serviceID, "echo", "'Service Check'"}
cmdResult := utils.Exec(wsPath, "docker-compose", cmdArgs)
if cmdResult != "" {
isRunning = true
}
}
edgeAppServices = append(edgeAppServices, EdgeAppService{ID: serviceID, IsRunning: isRunning})
}

View File

@ -2,7 +2,6 @@ package storage
import (
"fmt"
"strconv"
"os"
"path/filepath"
"strings"
@ -74,13 +73,12 @@ const (
DISK_TYPE_SDA DeviceIdentifier = "sda"
DISK_TYPE_MCBLK DeviceIdentifier = "mmcblk0"
DISK_TYPE_VDA DeviceIdentifier = "vda"
MIN_DISK_SIZE int = 1048576 // 1GB in bytes
)
func GetDeviceIdentifier(release_version diagnostics.ReleaseVersion) DeviceIdentifier {
switch release_version {
case diagnostics.CLOUD_VERSION:
return DISK_TYPE_SDA
return DISK_TYPE_VDA
case diagnostics.PROD_VERSION:
return DISK_TYPE_MCBLK
}
@ -136,13 +134,7 @@ func GetDevices(release_version diagnostics.ReleaseVersion) []Device {
currentDevice.InUse = currentDeviceInUseFlag
currentDeviceInUseFlag = false
currentPartitions = []Partition{}
size, err := strconv.Atoi(currentDevice.Size)
if err != nil {
size = 0
}
if size > MIN_DISK_SIZE {
devices = append(devices, currentDevice)
}
devices = append(devices, currentDevice)
} else {
firstDevice = false
}
@ -201,22 +193,8 @@ func GetDevices(release_version diagnostics.ReleaseVersion) []Device {
currentDevice.Status.Description = "Not configured"
}
currentDevice.InUse = currentDeviceInUseFlag
devices = append([]Device{currentDevice}, devices...) // Prepending the first device...
fmt.Println("Secondary Storage Devices Found: ", len(devices))
fmt.Println("Main Storage Device size: ", currentDevice.Size)
// only append device if size > 1GB
if currentDevice.Size != "" && currentDevice.Size != "0" {
// Convert size to int
// Convert string to int
size, err := strconv.Atoi(currentDevice.Size)
if err != nil {
size = 0
}
if size > MIN_DISK_SIZE {
devices = append([]Device{currentDevice}, devices...) // Prepending the first device...
}
}
devices = getDevicesSpaceUsage(devices)
return devices

View File

@ -92,22 +92,6 @@ func SetupCloudOptions() {
utils.WriteOption("EMAIL", cloudEnv["EMAIL"])
}
if cloudEnv["USERNAME"] != "" {
utils.WriteOption("USERNAME", cloudEnv["USERNAME"])
}
if cloudEnv["CLUSTER"] != "" {
utils.WriteOption("CLUSTER", cloudEnv["CLUSTER"])
}
if cloudEnv["CLUSTER_IP"] != "" {
utils.WriteOption("CLUSTER_IP", cloudEnv["CLUSTER_IP"])
}
if cloudEnv["CLUSTER_SSH_PORT"] != "" {
utils.WriteOption("CLUSTER_SSH_PORT", cloudEnv["CLUSTER_SSH_PORT"])
}
if cloudEnv["EDGEBOXIO_API_TOKEN"] != "" {
utils.WriteOption("EDGEBOXIO_API_TOKEN", cloudEnv["EDGEBOXIO_API_TOKEN"])
}
@ -116,37 +100,6 @@ func SetupCloudOptions() {
utils.Exec("/", "rm", []string{cloudEnvFileLocationPath})
}
func StartSystemLogger() {
fmt.Println("Starting system logger")
loggerPath := utils.GetPath(utils.LoggerPath)
utils.Exec(loggerPath, "make", []string{"start"})
}
// UpdateSystemLoggerServices: Updates the services.txt file with the services that are currently running
func UpdateSystemLoggerServices(services []string) {
fmt.Println("Updating system logger services:")
fmt.Println(services)
loggerPath := utils.GetPath(utils.LoggerPath)
utils.Exec(loggerPath, "bash", []string{"-c", "rm services.txt && touch services.txt"})
for _, service := range services {
fmt.Println("Adding " + service + " to services.txt")
utils.Exec(loggerPath, "bash", []string{"-c", "echo " + service + " >> services.txt"})
}
// Add empty line at the end of file (best practice)
utils.Exec(loggerPath, "bash", []string{"-c", "echo '' >> services.txt"})
}
// StartWs: Starts the webserver service for Edgeapps
func StartWs() {
wsPath := utils.GetPath(utils.WsPath)
fmt.Println("Starting WS")
cmdargs := []string{"-b"}
utils.Exec(wsPath, "./ws", cmdargs)
}
// StartService: Starts a service
func StartService(serviceID string) {
wsPath := utils.GetPath(utils.WsPath)
@ -425,94 +378,3 @@ func CopyFile(src string, dest string) error {
return nil
}
func CheckUpdates() {
fmt.Println("Checking for Edgebox System Updates.")
// Configure the service and start it
cmd := exec.Command("sh", "/home/system/components/updater/run.sh", "--check")
stdout, err := cmd.StdoutPipe()
if err != nil {
panic(err)
}
scanner := bufio.NewScanner(stdout)
err = cmd.Start()
if err != nil {
panic(err)
}
for scanner.Scan() {
// fmt.Println(scanner.Text())
text := scanner.Text()
fmt.Println(text)
}
if scanner.Err() != nil {
cmd.Process.Kill()
cmd.Wait()
fmt.Println("Error running updates check.")
utils.WriteOption("SYSTEM_UPDATES", "[]")
return
}
// Read targets.env file into JSON list structure
targets := []string{}
targetsFile, err := os.Open("/home/system/components/updater/targets.env")
if err != nil {
fmt.Println("No targets.env file found. Skipping.")
utils.WriteOption("SYSTEM_UPDATES", "[]")
return
}
defer targetsFile.Close()
scanner = bufio.NewScanner(targetsFile)
for scanner.Scan() {
text := scanner.Text()
// text line should look like: {"target": "<target>", "version": "<version>"}
target := strings.Split(text, "=")
newText := "{\"target\": \"" + strings.Replace(target[0], "_VERSION", "", -1) + "\", \"version\": \"" + target[1] + "\"}"
targets = append(targets, newText)
}
if scanner.Err() != nil {
fmt.Println("Error reading update targets file.")
utils.WriteOption("SYSTEM_UPDATES", "[]")
return
}
// convert targets to string
targetsString := strings.Join(targets, ",")
targetsString = "[" + targetsString + "]"
fmt.Println(targetsString)
// Write option with targets
utils.WriteOption("SYSTEM_UPDATES", targetsString)
}
func ApplyUpdates() {
fmt.Println("Applying Edgebox System Updates.")
utils.WriteOption("UPDATING_SYSTEM", "true")
// Configure the service and start it
cmd := exec.Command("sh", "/home/system/components/updater/run.sh", "--update")
stdout, err := cmd.StdoutPipe()
if err != nil {
panic(err)
}
scanner := bufio.NewScanner(stdout)
err = cmd.Start()
if err != nil {
panic(err)
}
for scanner.Scan() {
fmt.Println(scanner.Text())
text := scanner.Text()
fmt.Println(text)
}
if scanner.Err() != nil {
cmd.Process.Kill()
cmd.Wait()
panic(scanner.Err())
}
// If the system did not yet restart, set updating system to false
utils.WriteOption("UPDATING_SYSTEM", "false")
}

View File

@ -33,17 +33,6 @@ type Task struct {
Updated string `json:"updated"`
}
// TaskOption: Struct for Task Options (kv pair)
type TaskOption struct {
Key string `json:"key"`
Value string `json:"value"`
}
type TaskBasicAuth struct {
Username string `json:"username"`
Password string `json:"password"`
}
type taskSetupTunnelArgs struct {
DomainName string `json:"domain_name"`
}
@ -56,10 +45,6 @@ type taskInstallEdgeAppArgs struct {
ID string `json:"id"`
}
type taskInstallBulkEdgeAppsArgs struct {
IDS []string `json:"ids"`
}
type taskRemoveEdgeAppArgs struct {
ID string `json:"id"`
}
@ -68,21 +53,6 @@ type taskStopEdgeAppArgs struct {
ID string `json:"id"`
}
type taskSetEdgeAppOptionsArgs struct {
ID string `json:"id"`
// Options should be an array of "key":"value" pairs
Options []TaskOption `json:"options"`
}
type taskSetEdgeAppBasicAuthArgs struct {
ID string `json:"id"`
Login TaskBasicAuth `json:"login"`
}
type taskRemoveEdgeAppBasicAuthArgs struct {
ID string `json:"id"`
}
type taskEnableOnlineArgs struct {
ID string `json:"id"`
InternetURL string `json:"internet_url"`
@ -104,10 +74,6 @@ type taskSetupBackupsArgs struct {
RepositoryPassword string `json:"repository_password"`
}
type taskStartShellArgs struct {
Timeout int `json:"timeout"`
}
const STATUS_CREATED int = 0
const STATUS_EXECUTING int = 1
@ -150,33 +116,6 @@ func GetNextTask() Task {
}
// GetExecutingTasks : Performs a MySQL query over the device's Edgebox API to obtain all tasks that are currently executing
func GetExecutingTasks() []Task {
// Will try to connect to API database, which should be running locally under WS.
db, err := sql.Open("sqlite3", utils.GetSQLiteDbConnectionDetails())
if err != nil {
panic(err.Error())
}
results, err := db.Query("SELECT id, task, args, status, result, created, updated FROM task WHERE status = 1;")
if err != nil {
panic(err.Error())
}
var tasks []Task
for results.Next() {
// for each row, scan the result into our task composite object
var task Task
err = results.Scan(&task.ID, &task.Task, &task.Args, &task.Status, &task.Result, &task.Created, &task.Updated)
if err != nil {
panic(err.Error()) // proper error handling instead of panic in your app
}
tasks = append(tasks, task)
}
results.Close()
db.Close()
return tasks
}
// ExecuteTask : Performs execution of the given task, updating the task status as it goes, and publishing the task result
func ExecuteTask(task Task) Task {
@ -275,22 +214,6 @@ func ExecuteTask(task Task) Task {
taskResult := taskDisableTunnel()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "start_shell":
log.Println("Starting SSHX.io Shell")
var args taskStartShellArgs
err := json.Unmarshal([]byte(task.Args.String), &args)
if err != nil {
log.Printf("Error reading arguments or start_shell task: %s", err)
} else {
taskResult := taskStartShell(args)
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "stop_shell":
log.Println("Stopping SSHX.io Shell...")
taskResult := taskStopShell()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "install_edgeapp":
log.Println("Installing EdgeApp...")
@ -303,18 +226,6 @@ func ExecuteTask(task Task) Task {
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "install_bulk_edgeapps":
log.Println("Installing Bulk EdgeApps...")
var args taskInstallBulkEdgeAppsArgs
err := json.Unmarshal([]byte(task.Args.String), &args)
if err != nil {
log.Printf("Error reading arguments of install_bulk_edgeapps task: %s", err)
} else {
taskResult := taskInstallBulkEdgeApps(args)
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "remove_edgeapp":
log.Println("Removing EdgeApp...")
@ -351,43 +262,6 @@ func ExecuteTask(task Task) Task {
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "set_edgeapp_options":
log.Println("Setting EdgeApp Options...")
var args taskSetEdgeAppOptionsArgs
// {"id":"podgrab","options":{"PODGRAB_PASSWORD":"fumarmata"}}
err := json.Unmarshal([]byte(task.Args.String), &args)
if err != nil {
log.Printf("Error reading arguments of set_edgeapp_options task: %s", err)
} else {
taskResult := taskSetEdgeAppOptions(args)
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "set_edgeapp_basic_auth":
log.Println("Settig EdgeApp Basic Authentication...")
var args taskSetEdgeAppBasicAuthArgs
err := json.Unmarshal([]byte(task.Args.String), &args)
if err != nil {
log.Printf("Error reading arguments of set_edgeapp_basic_auth task: %s", err)
} else {
taskResult := taskSetEdgeAppBasicAuth(args)
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "remove_edgeapp_basic_auth":
log.Println("Removing EdgeApp Basic Authentication...")
var args taskRemoveEdgeAppBasicAuthArgs
err := json.Unmarshal([]byte(task.Args.String), &args)
if err != nil {
log.Printf("Error reading arguments of remove_edgeapp_basic_auth task: %s", err)
} else {
taskResult := taskRemoveEdgeAppBasicAuth(args)
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "enable_online":
log.Println("Enabling online access to EdgeApp...")
@ -430,25 +304,6 @@ func ExecuteTask(task Task) Task {
taskResult := taskDisablePublicDashboard()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "check_updates":
log.Println("Checking for updates...")
taskResult := taskCheckSystemUpdates()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "apply_updates":
log.Println("Updating Edgebox System...")
is_updating := utils.ReadOption("UPDATING_SYSTEM")
if is_updating == "true" {
log.Println("Edgebox update was running... Probably system restarted. Finishing update...")
utils.WriteOption("UPDATING_SYSTEM", "false")
task.Result = sql.NullString{String: "{result: true}", Valid: true}
} else {
log.Println("Updating Edgebox System...")
taskResult := taskUpdateSystem()
task.Result = sql.NullString{String: taskResult, Valid: true}
}
}
}
@ -469,7 +324,6 @@ func ExecuteTask(task Task) Task {
if err != nil {
log.Fatal(err.Error())
}
} else {
fmt.Println("Error executing task with result: " + task.Result.String)
_, err = statement.Exec(STATUS_ERROR, "Error", formatedDatetime, strconv.Itoa(task.ID)) // Execute SQL Statement with Error info
@ -520,12 +374,8 @@ func ExecuteSchedules(tick int) {
log.Println("Uptime is " + uptime + " seconds (" + system.GetUptimeFormatted() + ")")
log.Println(taskGetStorageDevices())
taskStartWs()
log.Println(taskGetEdgeApps())
taskUpdateSystemLoggerServices()
taskRecoverFromUpdate()
taskCheckSystemUpdates()
}
if tick%5 == 0 {
@ -537,7 +387,6 @@ func ExecuteSchedules(tick int) {
if tick%30 == 0 {
// Executing every 30 ticks
log.Println(taskGetEdgeApps())
taskUpdateSystemLoggerServices()
// RESET SOME VARIABLES HERE IF NEEDED, SINCE SYSTEM IS UNBLOCKED
utils.WriteOption("BACKUP_IS_WORKING", "0")
@ -572,13 +421,6 @@ func ExecuteSchedules(tick int) {
if tick%3600 == 0 {
// Executing every 3600 ticks (1 hour)
taskCheckSystemUpdates()
}
if tick%86400 == 0 {
// Executing every 86400 ticks (+/1 day)
// Ensuring we run a normal build, setting up avahi domain names fresh in the network
taskStartWs()
}
// Just add a schedule here if you need a custom one (every "tick hour", every "tick day", etc...)
@ -991,19 +833,12 @@ func taskSetupTunnel(args taskSetupTunnelArgs) string {
}
func taskStartTunnel() string {
fmt.Println("Executing taskStartTunnel")
// Read tunnel status to check if cloudflare is configured
tunnelStatus := utils.ReadOption("TUNNEL_STATUS")
if tunnelStatus != "" {
// Only start cloudflared if we have a tunnel configured
system.StartService("cloudflared")
domainName := utils.ReadOption("DOMAIN_NAME")
status := "{\"status\": \"connected\", \"domain\": \"" + domainName + "\"}"
utils.WriteOption("TUNNEL_STATUS", status)
}
return "{\"status\": \"ok\"}"
fmt.Println("Executing taskStartTunnel")
system.StartService("cloudflared")
domainName := utils.ReadOption("DOMAIN_NAME")
status := "{\"status\": \"connected\", \"domain\": \"" + domainName + "\"}"
utils.WriteOption("TUNNEL_STATUS", status)
return "{\"status\": \"ok\"}"
}
func taskStopTunnel() string {
@ -1025,80 +860,6 @@ func taskDisableTunnel() string {
return "{\"status\": \"ok\"}"
}
func taskStartShell(args taskStartShellArgs) string {
fmt.Println("Executing taskStartShell")
wsPath := utils.GetPath(utils.WsPath)
// kill the process if its running
utils.Exec(wsPath, "killall", []string{"sshx"})
cmd := exec.Command("/usr/local/bin/sshx", "--quiet", "--shell", "bash")
stdout, err := cmd.StdoutPipe()
if err != nil {
panic(err)
}
scanner := bufio.NewScanner(stdout)
err = cmd.Start()
if err != nil {
panic(err)
}
url := ""
timeout := args.Timeout
for scanner.Scan() {
fmt.Println(scanner.Text())
text := scanner.Text()
if strings.Contains(text, "https://") {
url = text
fmt.Println("Shell start is responding with URL: " + url)
utils.WriteOption("SHELL_URL", url)
utils.WriteOption("SHELL_STATUS", "running")
break
}
}
if scanner.Err() != nil {
cmd.Process.Kill()
cmd.Wait()
panic(scanner.Err())
}
go func() {
fmt.Println("Running shell async")
// cmd.Wait()
// Keep retrying to calculate timeout to know when to kill the process
for {
timeout = timeout - 1
if timeout <= 0 {
fmt.Println("Timeout reached, killing process...")
utils.Exec(wsPath, "killall sshx", []string{})
utils.WriteOption("SHELL_STATUS", "not_running")
break
}
if timeout%10 == 0 {
fmt.Println("Active Shell Timeout is " + fmt.Sprint(timeout) + " seconds")
}
time.Sleep(1 * time.Second)
}
}()
return "{\"status\": \"ok\"}"
}
func taskStopShell() string {
fmt.Println("Executing taskStopShell")
wsPath := utils.GetPath(utils.WsPath)
// kill the process if its running
utils.Exec(wsPath, "killall", []string{"sshx"})
utils.WriteOption("SHELL_STATUS", "not_running")
return "{\"status\": \"ok\"}"
}
func taskInstallEdgeApp(args taskInstallEdgeAppArgs) string {
fmt.Println("Executing taskInstallEdgeApp for " + args.ID)
@ -1109,16 +870,6 @@ func taskInstallEdgeApp(args taskInstallEdgeAppArgs) string {
return string(resultJSON)
}
func taskInstallBulkEdgeApps(args taskInstallBulkEdgeAppsArgs) string {
fmt.Println("Executing taskInstallBulkEdgeApps for " + strings.Join(args.IDS, ", "))
// args.Apps is a list of edgeapp ids
edgeapps.SetEdgeAppBulkInstalled(args.IDS)
taskGetEdgeApps()
return "{\"status\": \"ok\"}"
}
func taskRemoveEdgeApp(args taskRemoveEdgeAppArgs) string {
fmt.Println("Executing taskRemoveEdgeApp for " + args.ID)
@ -1151,128 +902,6 @@ func taskStopEdgeApp(args taskStopEdgeAppArgs) string {
return string(resultJSON)
}
func taskSetEdgeAppOptions(args taskSetEdgeAppOptionsArgs) string {
// Id is the edgeapp id
appID := args.ID
// Open the file to write the options,
// it is an env file in /home/system/components/apps/<app_id>/edgeapp.env
// Get the path to the edgeapp.env file
edgeappEnvPath := "/home/system/components/apps/" + appID + "/edgeapp.env"
// If the file does not exist, create it
if _, err := os.Stat(edgeappEnvPath); os.IsNotExist(err) {
// Create the file
_, err := os.Create(edgeappEnvPath)
if err != nil {
log.Printf("Error creating edgeapp.env file: %s", err)
}
}
// It is an env file, so we can use go-dotenv to write the options
// Open the file
edgeappEnvFile, err := os.OpenFile(edgeappEnvPath, os.O_WRONLY, 0600)
if err != nil {
log.Printf("Error opening edgeapp.env file: %s", err)
}
// Write the options to the file
for _, value := range args.Options {
// Write the option to the file
_, err := edgeappEnvFile.WriteString(value.Key + "=" + value.Value + "\n")
if err != nil {
log.Printf("Error writing option to edgeapp.env file: %s", err)
}
}
// Close the file
err = edgeappEnvFile.Close()
if err != nil {
log.Printf("Error closing edgeapp.env file: %s", err)
}
result := edgeapps.GetEdgeAppStatus(appID)
resultJSON, _ := json.Marshal(result)
system.StartWs()
taskGetEdgeApps() // This task will imediatelly update the entry in the api database.
return string(resultJSON)
}
func taskSetEdgeAppBasicAuth(args taskSetEdgeAppBasicAuthArgs) string {
// Id is the edgeapp id
appID := args.ID
// Open the file to write the options,
// it is an env file in /home/system/components/apps/<app_id>/auth.env
// Get the path to the auth.env file
edgeappAuthEnvPath := "/home/system/components/apps/" + appID + "/auth.env"
// If the file does not exist, create it
if _, err := os.Stat(edgeappAuthEnvPath); os.IsNotExist(err) {
// Create the file
_, err := os.Create(edgeappAuthEnvPath)
if err != nil {
log.Printf("Error creating auth.env file: %s", err)
}
}
// It is an env file, so we can use go-dotenv to write the options
// Open the file
edgeappAuthEnvFile, err := os.OpenFile(edgeappAuthEnvPath, os.O_WRONLY, 0600)
if err != nil {
log.Printf("Error opening auth.env file: %s", err)
}
// Write the login values to the file
_, err = edgeappAuthEnvFile.WriteString("USERNAME=" + args.Login.Username + "\n" + "PASSWORD=" + args.Login.Password + "\n")
if err != nil {
log.Printf("Error writing credentials to auth.env file: %s", err)
}
// Close the file
err = edgeappAuthEnvFile.Close()
if err != nil {
log.Printf("Error closing auth.env file: %s", err)
}
result := edgeapps.GetEdgeAppStatus(appID)
resultJSON, _ := json.Marshal(result)
system.StartWs()
taskGetEdgeApps() // This task will imediatelly update the entry in the api database.
return string(resultJSON)
}
func taskRemoveEdgeAppBasicAuth(args taskRemoveEdgeAppBasicAuthArgs) string {
// Id is the edgeapp id
appID := args.ID
// Get the path to the auth.env file
edgeappAuthEnvFile := "/auth.env"
fmt.Println("Removing auth.env file" + edgeappAuthEnvFile)
err := os.Remove(utils.GetPath(utils.EdgeAppsPath) + args.ID + edgeappAuthEnvFile)
if err != nil {
log.Fatal(err)
}
result := edgeapps.GetEdgeAppStatus(appID)
resultJSON, _ := json.Marshal(result)
system.StartWs()
taskGetEdgeApps() // This task will imediatelly update the entry in the api database.
return string(resultJSON)
}
func taskEnableOnline(args taskEnableOnlineArgs) string {
fmt.Println("Executing taskEnableOnline for " + args.ID)
@ -1316,39 +945,6 @@ func taskDisablePublicDashboard() string {
return "{result: false}"
}
func taskCheckSystemUpdates() string {
fmt.Println("Executing taskCheckSystemUpdates")
system.CheckUpdates()
return "{result: true}"
}
func taskUpdateSystem() string {
fmt.Println("Executing taskUpdateSystem")
system.ApplyUpdates()
utils.WriteOption("LAST_UPDATE", strconv.FormatInt(time.Now().Unix(), 10))
return "{result: true}"
}
func taskRecoverFromUpdate() string {
fmt.Println("Executing taskRecoverFromUpdate")
executing_tasks := GetExecutingTasks()
// Filter out the task with task value "update_system"
filteredTasks := []Task{}
for _, task := range executing_tasks {
if task.Task != "update_system" {
filteredTasks = append(filteredTasks, task)
}
}
// If tasks is not empty, Get the last task
if len(filteredTasks) > 0 {
lastTask := filteredTasks[len(filteredTasks)-1]
ExecuteTask(lastTask)
}
return "{result: true}"
}
func taskSetReleaseVersion() string {
fmt.Println("Executing taskSetReleaseVersion")
@ -1358,35 +954,6 @@ func taskSetReleaseVersion() string {
return diagnostics.Version
}
func taskUpdateSystemLoggerServices() string {
fmt.Println("Executing taskUpdateSystemLoggerServices")
// The input is an array of strings
// Each string is a service name to be logged
var input []string
// Get the services
edgeAppsList := utils.ReadOption("EDGEAPPS_LIST")
var edgeApps []edgeapps.EdgeApp
err := json.Unmarshal([]byte(edgeAppsList), &edgeApps)
if err != nil {
log.Fatalf("failed to unmarshal EDGEAPPS_LIST: %v", err)
}
for _, edgeApp := range edgeApps {
for _, service := range edgeApp.Services {
input = append(input, service.ID)
}
}
input = append(input, "edgeboxctl")
input = append(input, "tunnel")
// Run the system logger
system.UpdateSystemLoggerServices(input)
return "{\"status\": \"ok\"}"
}
func taskGetEdgeApps() string {
fmt.Println("Executing taskGetEdgeApps")
@ -1433,8 +1000,3 @@ func taskSetupCloudOptions() {
fmt.Println("Executing taskSetupCloudOptions")
system.SetupCloudOptions()
}
func taskStartWs() {
fmt.Println("Executing taskStartWs")
system.StartWs()
}

View File

@ -111,8 +111,6 @@ const ApiPath string = "apiPath"
const EdgeAppsPath string = "edgeAppsPath"
const EdgeAppsBackupPath string = "edgeAppsBackupPath"
const WsPath string = "wsPath"
const LoggerPath string = "loggerPath"
// GetPath : Returns either the hardcoded path, or a overwritten value via .env file at project root. Register paths here for seamless working code between dev and prod environments ;)
func GetPath(pathKey string) string {
@ -132,7 +130,7 @@ func GetPath(pathKey string) string {
if env["CLOUD_ENV_FILE_LOCATION"] != "" {
targetPath = env["CLOUD_ENV_FILE_LOCATION"]
} else {
targetPath = "/home/system/components/api/cloud.env"
targetPath = "/home/system/components/edgeboxctl/cloud.env"
}
case ApiEnvFileLocation:
@ -174,13 +172,6 @@ func GetPath(pathKey string) string {
targetPath = "/home/system/components/ws/"
}
case LoggerPath:
if env["LOGGER_PATH"] != "" {
targetPath = env["LOGGER_PATH"]
} else {
targetPath = "/home/system/components/logger/"
}
case BackupPasswordFileLocation:
if env["BACKUP_PASSWORD_FILE_LOCATION"] != "" {