Add API endpoint for accessing repo topics

models/topic.go

@@ -54,11 +54,39 @@ func (err ErrTopicNotExist) Error() string {
 	return fmt.Sprintf("topic is not exist [name: %s]", err.Name)
 }
 
-// ValidateTopic checks topics by length and match pattern rules
+// ValidateTopic checks a topic by length and match pattern rules
 func ValidateTopic(topic string) bool {
 	return len(topic) <= 35 && topicPattern.MatchString(topic)
 }
 
+// SanitizeAndValidateTopics sanitizes and checks an array or topics
+func SanitizeAndValidateTopics(topics []string) (validTopics []string, invalidTopics []string) {
+	validTopics = make([]string, 0)
+	invalidTopics = make([]string, 0)
+
+	LOOP_TOPICS:
+	for _, topic := range topics {
+		topic = strings.TrimSpace(strings.ToLower(topic))
+		// ignore empty string
+		if len(topic) == 0 {
+			continue LOOP_TOPICS
+		}
+		// ignore same topic twice
+		for _, vTopic := range validTopics {
+			if topic == vTopic {
+				continue LOOP_TOPICS
+			}
+		}
+		if ValidateTopic(topic) {
+			validTopics = append(validTopics, topic)
+		} else {
+			invalidTopics = append(invalidTopics, topic)
+		}
+	}
+
+	return validTopics, invalidTopics
+}
+
 // GetTopicByName retrieves topic by name
 func GetTopicByName(name string) (*Topic, error) {
 	var topic Topic
@@ -70,6 +98,52 @@ func GetTopicByName(name string) (*Topic, error) {
 	return &topic, nil
 }
 
+// addTopicByNameToRepo adds a topic name to a repo and increments the topic count.
+// Returns topic after the addition
+func addTopicByNameToRepo(repoID int64, topicName string, e Engine) (*Topic, error) {
+	var topic Topic
+	if has, err := e.Where("name = ?", topicName).Get(&topic); err != nil {
+		return nil, err
+	} else if !has {
+		topic.Name = topicName
+		topic.RepoCount = 1
+		if _, err := e.Insert(&topic); err != nil {
+			return nil, err
+		}
+	} else {
+		topic.RepoCount++
+		if _, err := e.ID(topic.ID).Cols("repo_count").Update(&topic); err != nil {
+			return nil, err
+		}
+	}
+
+	if _, err := e.Insert(&RepoTopic{
+		RepoID:  repoID,
+		TopicID: topic.ID,
+	}); err != nil {
+		return nil, err
+	}
+
+	return &topic, nil
+}
+
+// removeTopicFromRepo remove a topic from a repo and decrements the topic repo count
+func removeTopicFromRepo(repoID int64, topic *Topic, e Engine) error {
+	topic.RepoCount--
+	if _, err := e.ID(topic.ID).Cols("repo_count").Update(topic); err != nil {
+		return err
+	}
+
+	if _, err := e.Delete(&RepoTopic{
+		RepoID:  repoID,
+		TopicID: topic.ID,
+	}); err != nil {
+		return err
+	}
+
+	return nil
+}
+
 // FindTopicOptions represents the options when fdin topics
 type FindTopicOptions struct {
 	RepoID  int64
@@ -103,6 +177,50 @@ func FindTopics(opts *FindTopicOptions) (topics []*Topic, err error) {
 	return topics, sess.Desc("topic.repo_count").Find(&topics)
 }
 
+// GetRepoTopic retrives topic from name for a repo if it exist
+func GetRepoTopicByName(repoID int64, topicName string) (*Topic, error) {
+	var cond = builder.NewCond()
+	var topic Topic
+	cond = cond.And(builder.Eq{"repo_topic.repo_id": repoID}).And(builder.Eq{"topic.name": topicName})
+	sess := x.Table("topic").Where(cond)
+	sess.Join("INNER", "repo_topic", "repo_topic.topic_id = topic.id")
+	has, err := sess.Get(&topic)
+	if has {
+		return &topic, err
+	}
+	return nil, err
+}
+
+// AddTopic adds a topic name to a repository (if it does not already have it)
+func AddTopic(repoID int64, topicName string) (*Topic, error) {
+	topic, err := GetRepoTopicByName(repoID, topicName)
+	if err != nil {
+		return nil, err
+	}
+	if topic != nil {
+		// Repo already have topic
+		return topic, nil
+	}
+
+	return addTopicByNameToRepo(repoID, topicName, x)
+}
+
+// DeleteTopic removes a topic name from a repository (if it has it)
+func DeleteTopic(repoID int64, topicName string) (*Topic, error) {
+	topic, err := GetRepoTopicByName(repoID, topicName)
+	if err != nil {
+		return nil, err
+	}
+	if topic == nil {
+		// Repo doesn't have topic, can't be removed
+		return nil, nil
+	}
+
+	err = removeTopicFromRepo(repoID, topic, x)
+
+	return topic, err
+}
+
 // SaveTopics save topics to a repository
 func SaveTopics(repoID int64, topicNames ...string) error {
 	topics, err := FindTopics(&FindTopicOptions{
@@ -152,40 +270,15 @@ func SaveTopics(repoID int64, topicNames ...string) error {
 	}
 
 	for _, topicName := range addedTopicNames {
-		var topic Topic
-		if has, err := sess.Where("name = ?", topicName).Get(&topic); err != nil {
-			return err
-		} else if !has {
-			topic.Name = topicName
-			topic.RepoCount = 1
-			if _, err := sess.Insert(&topic); err != nil {
-				return err
-			}
-		} else {
-			topic.RepoCount++
-			if _, err := sess.ID(topic.ID).Cols("repo_count").Update(&topic); err != nil {
-				return err
-			}
-		}
-
-		if _, err := sess.Insert(&RepoTopic{
-			RepoID:  repoID,
-			TopicID: topic.ID,
-		}); err != nil {
+		_, err := addTopicByNameToRepo(repoID, topicName, sess)
+		if err != nil {
 			return err
 		}
 	}
 
 	for _, topic := range removeTopics {
-		topic.RepoCount--
-		if _, err := sess.ID(topic.ID).Cols("repo_count").Update(topic); err != nil {
-			return err
-		}
-
-		if _, err := sess.Delete(&RepoTopic{
-			RepoID:  repoID,
-			TopicID: topic.ID,
-		}); err != nil {
+		err := removeTopicFromRepo(repoID, topic, sess)
+		if err != nil {
 			return err
 		}
 	}

modules/structs/repo_topic.go

@@ -0,0 +1,24 @@
+// Copyright 2019 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package structs
+
+import (
+	"time"
+)
+
+// TopicResponse for returning topics
+type TopicResponse struct {
+	ID        int64     `json:"id"`
+	Name      string    `json:"topic_name"`
+	RepoCount int       `json:"repo_count"`
+	Created   time.Time `json:"created"`
+	Updated   time.Time `json:"updated"`
+}
+
+// RepoTopicOptions a collection of repo topic names
+type RepoTopicOptions struct {
+	// list of topic names
+	Topics []string `json:"topics"`
+}

public/js/index.js

@@ -2936,14 +2936,14 @@ function initTopicbar() {
                     let found = false;
                     for (let i=0;i < res.topics.length;i++) {
                         // skip currently added tags
-                        if (current_topics.indexOf(res.topics[i].Name) != -1){
+                        if (current_topics.indexOf(res.topics[i].topic_name) != -1){
                             continue;
                         }
 
-                        if (res.topics[i].Name.toLowerCase() === query.toLowerCase()){
+                        if (res.topics[i].topic_name.toLowerCase() === query.toLowerCase()){
                             found_query = true;
                         }
-                        formattedResponse.results.push({"description": res.topics[i].Name, "data-value": res.topics[i].Name});
+                        formattedResponse.results.push({"description": res.topics[i].topic_name, "data-value": res.topics[i].topic_name});
                         found = true;
                     }
                     formattedResponse.success = found;

routers/api/v1/api.go

@@ -775,6 +775,14 @@ func RegisterRoutes(m *macaron.Macaron) {
 						m.Delete("", bind(api.DeleteFileOptions{}), repo.DeleteFile)
 					}, reqRepoWriter(models.UnitTypeCode), reqToken())
 				}, reqRepoReader(models.UnitTypeCode))
+				m.Group("/topics", func() {
+					m.Combo("").Get(repo.ListTopics).
+						Put(reqToken(), reqRepoWriter(models.UnitTypeCode), bind(api.RepoTopicOptions{}), repo.UpdateTopics)
+					m.Group("/:topic", func() {
+						m.Combo("").Put(reqToken(), reqRepoWriter(models.UnitTypeCode), repo.AddTopic).
+							Delete(reqToken(), reqRepoWriter(models.UnitTypeCode), repo.DeleteTopic)
+					})
+				}, reqRepoReader(models.UnitTypeCode))
 			}, repoAssignment())
 		})
 

routers/api/v1/convert/convert.go

@@ -291,3 +291,14 @@ func ToCommitMeta(repo *models.Repository, tag *git.Tag) *api.CommitMeta {
 		URL: util.URLJoin(repo.APIURL(), "git/commits", tag.ID.String()),
 	}
 }
+
+// ToTopicResponse convert from models.Topic to api.TopicResponse
+func ToTopicResponse(topic *models.Topic) *api.TopicResponse {
+	return &api.TopicResponse{
+		ID:        topic.ID,
+		Name:      topic.Name,
+		RepoCount: topic.RepoCount,
+		Created:   topic.CreatedUnix.AsTime(),
+		Updated:   topic.UpdatedUnix.AsTime(),
+	}
+}

routers/api/v1/repo/repo.go

@@ -866,45 +866,3 @@ func MirrorSync(ctx *context.APIContext) {
 	go models.MirrorQueue.Add(repo.ID)
 	ctx.Status(200)
 }
-
-// TopicSearch search for creating topic
-func TopicSearch(ctx *context.Context) {
-	// swagger:operation GET /topics/search repository topicSearch
-	// ---
-	// summary: search topics via keyword
-	// produces:
-	//   - application/json
-	// parameters:
-	//   - name: q
-	//     in: query
-	//     description: keywords to search
-	//     required: true
-	//     type: string
-	// responses:
-	//   "200":
-	//     "$ref": "#/responses/Repository"
-	if ctx.User == nil {
-		ctx.JSON(403, map[string]interface{}{
-			"message": "Only owners could change the topics.",
-		})
-		return
-	}
-
-	kw := ctx.Query("q")
-
-	topics, err := models.FindTopics(&models.FindTopicOptions{
-		Keyword: kw,
-		Limit:   10,
-	})
-	if err != nil {
-		log.Error("SearchTopics failed: %v", err)
-		ctx.JSON(500, map[string]interface{}{
-			"message": "Search topics failed.",
-		})
-		return
-	}
-
-	ctx.JSON(200, map[string]interface{}{
-		"topics": topics,
-	})
-}