Load Application Service Configuration Files (#377)

Signed-off-by: Andrew Morgan (https://amorgan.xyz) <andrew@amorgan.xyz>

src/github.com/matrix-org/dendrite/common/config/appservice.go

@@ -0,0 +1,79 @@
+// Copyright 2017 Andrew Morgan <andrew@amorgan.xyz>
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package config
+
+import (
+	"io/ioutil"
+	"path/filepath"
+
+	"gopkg.in/yaml.v2"
+)
+
+// ApplicationServiceNamespace is the namespace that a specific application
+// service has management over.
+type ApplicationServiceNamespace struct {
+	// Whether or not the namespace is managed solely by this application service
+	Exclusive bool `yaml:"exclusive"`
+	// A regex pattern that represents the namespace
+	Regex string `yaml:"regex"`
+}
+
+// ApplicationService represents a Matrix application service.
+// https://matrix.org/docs/spec/application_service/unstable.html
+type ApplicationService struct {
+	// User-defined, unique, persistent ID of the application service
+	ID string `yaml:"id"`
+	// Base URL of the application service
+	URL string `yaml:"url"`
+	// Application service token provided in requests to a homeserver
+	ASToken string `yaml:"as_token"`
+	// Homeserver token provided in requests to an application service
+	HSToken string `yaml:"hs_token"`
+	// Localpart of application service user
+	SenderLocalpart string `yaml:"sender_localpart"`
+	// Information about an application service's namespaces
+	Namespaces map[string][]ApplicationServiceNamespace `yaml:"namespaces"`
+}
+
+func loadAppservices(config *Dendrite) error {
+	// Iterate through and return all the Application Services
+	for _, configPath := range config.ApplicationServices.ConfigFiles {
+		// Create a new application service
+		var appservice ApplicationService
+
+		// Create an absolute path from a potentially relative path
+		absPath, err := filepath.Abs(configPath)
+		if err != nil {
+			return err
+		}
+
+		// Read the application service's config file
+		configData, err := ioutil.ReadFile(absPath)
+		if err != nil {
+			return err
+		}
+
+		// Load the config data into our struct
+		if err = yaml.UnmarshalStrict(configData, &appservice); err != nil {
+			return err
+		}
+
+		// Append the parsed application service to the global config
+		config.Derived.ApplicationServices = append(
+			config.Derived.ApplicationServices, appservice)
+	}
+
+	return nil
+}

src/github.com/matrix-org/dendrite/common/config/config.go

@@ -186,7 +186,7 @@ type Dendrite struct {
 		// Hardcoded Username and Password
 		Username string `yaml:"turn_username"`
 		Password string `yaml:"turn_password"`
-	}
+	} `yaml:"turn"`
 
 	// The internal addresses the components will listen on.
 	// These should not be exposed externally as they expose metrics and debugging APIs.
@@ -204,7 +204,14 @@ type Dendrite struct {
 	Tracing struct {
 		// The config for the jaeger opentracing reporter.
 		Jaeger jaegerconfig.Configuration `yaml:"jaeger"`
-	}
+	} `yaml:"tracing"`
+
+	// Application Services
+	// https://matrix.org/docs/spec/application_service/unstable.html
+	ApplicationServices struct {
+		// Configuration files for various application services
+		ConfigFiles []string `yaml:"config_files"`
+	} `yaml:"application_services"`
 
 	// Any information derived from the configuration options for later use.
 	Derived struct {
@@ -219,7 +226,11 @@ type Dendrite struct {
 			// registration in order to complete registration stages.
 			Params map[string]interface{} `json:"params"`
 		}
-	}
+
+		// Application Services parsed from their config files
+		// The paths of which were given above in the main config file
+		ApplicationServices []ApplicationService
+	} `yaml:"-"`
 }
 
 // A Path on the filesystem.
@@ -323,7 +334,8 @@ func loadConfig(
 
 	for _, certPath := range config.Matrix.FederationCertificatePaths {
 		absCertPath := absPath(basePath, certPath)
-		pemData, err := readFile(absCertPath)
+		var pemData []byte
+		pemData, err = readFile(absCertPath)
 		if err != nil {
 			return nil, err
 		}
@@ -337,14 +349,17 @@ func loadConfig(
 	config.Media.AbsBasePath = Path(absPath(basePath, config.Media.BasePath))
 
 	// Generate data from config options
-	config.derive()
+	err = config.derive()
+	if err != nil {
+		return nil, err
+	}
 
 	return &config, nil
 }
 
 // derive generates data that is derived from various values provided in
 // the config file.
-func (config *Dendrite) derive() {
+func (config *Dendrite) derive() error {
 	// Determine registrations flows based off config values
 
 	config.Derived.Registration.Params = make(map[string]interface{})
@@ -360,6 +375,13 @@ func (config *Dendrite) derive() {
 		config.Derived.Registration.Flows = append(config.Derived.Registration.Flows,
 			authtypes.Flow{Stages: []authtypes.LoginType{authtypes.LoginTypeDummy}})
 	}
+
+	// Load application service configuration files
+	if err := loadAppservices(config); err != nil {
+		return err
+	}
+
+	return nil
 }
 
 // setDefaults sets default config values if they are not explicitly set.