blob: ccd58cecd526f6cd389ba3fd2caa90118a692bc0 [file] [log] [blame]
// Copyright 2018 The LUCI Authors.
// 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package config
import (
configInterface ""
var EmailTemplateFuncs = map[string]interface{}{
"time": func(ts *timestamp.Timestamp) time.Time {
t, _ := ptypes.Timestamp(ts)
return t
"formatBuilderID": protoutil.FormatBuilderID,
// emailTemplateFilenameRegexp returns a regular expression for email template
// file names.
func emailTemplateFilenameRegexp(c context.Context) *regexp.Regexp {
appId := info.AppID(c)
pattern := fmt.Sprintf(`^%s+/email-templates/([a-z][a-z0-9_]*)\.template$`, regexp.QuoteMeta(appId))
return regexp.MustCompile(pattern)
// EmailTemplate is a Datastore entity directly under Project entity that
// represents an email template.
// It is managed by the cron job that ingests configs.
type EmailTemplate struct {
// ProjectKey is a datastore key of the LUCI project containing this email
// template.
ProjectKey *datastore.Key `gae:"$parent"`
// Name identifies the email template. It is unique within the project.
Name string `gae:"$id"`
// SubjectTextTemplate is a text.Template of the email subject.
SubjectTextTemplate string `gae:",noindex"`
// BodyHTMLTemplate is a html.Template of the email body.
BodyHTMLTemplate string `gae:",noindex"`
// DefinitionURL is a URL to human-viewable page that contains the definition
// of this email template.
DefinitionURL string `gae:",noindex"`
// fetchAllEmailTemplates fetches all valid email templates of the project from
// a config service. Returned EmailTemplate entities do not have ProjectKey set.
func fetchAllEmailTemplates(c context.Context, configService configInterface.Interface, projectId string) (map[string]*EmailTemplate, error) {
configSet := configInterface.ProjectSet(projectId)
files, err := configService.ListFiles(c, configSet)
if err != nil {
return nil, err
ret := map[string]*EmailTemplate{}
// This runs in a cron job. It is not performance critical, so we don't have
// to fetch files concurrently.
filenameRegexp := emailTemplateFilenameRegexp(c)
for _, f := range files {
m := filenameRegexp.FindStringSubmatch(f)
if m == nil {
// Not a template file or a template of another instance of luci-notify.
templateName := m[1]
logging.Infof(c, "fetching email template from %s:%s", configSet, f)
config, err := configService.GetConfig(c, configSet, f, false)
if err != nil {
return nil, errors.Annotate(err, "failed to fetch %q", f).Err()
subject, body, err := splitEmailTemplateFile(config.Content)
if err != nil {
// Should not happen. luci-config should not have passed this commit in
// because luci-notify exposes its validation code to luci-conifg.
logging.Warningf(c, "invalid email template content in %q: %s", f, err)
ret[templateName] = &EmailTemplate{
Name: templateName,
SubjectTextTemplate: subject,
BodyHTMLTemplate: body,
DefinitionURL: config.ViewURL,
return ret, nil
// splitEmailTemplateFile splits an email template file into subject and body.
// Does not validate their syntaxes.
// See notify.proto for file format.
func splitEmailTemplateFile(content string) (subject, body string, err error) {
if len(content) == 0 {
return "", "", fmt.Errorf("empty file")
parts := strings.SplitN(content, "\n", 3)
switch {
case len(parts) < 3:
return "", "", fmt.Errorf("less than three lines")
case len(strings.TrimSpace(parts[1])) > 0:
return "", "", fmt.Errorf("second line is not blank: %q", parts[1])
return strings.TrimSpace(parts[0]), strings.TrimSpace(parts[2]), nil