Added Channel.Purpose on the server

api/channel.go

@@ -23,6 +23,7 @@ func InitChannel(r *mux.Router) {
 	sr.Handle("/create_direct", ApiUserRequired(createDirectChannel)).Methods("POST")
 	sr.Handle("/update", ApiUserRequired(updateChannel)).Methods("POST")
 	sr.Handle("/update_header", ApiUserRequired(updateChannelHeader)).Methods("POST")
+	sr.Handle("/update_purpose", ApiUserRequired(updateChannelPurpose)).Methods("POST")
 	sr.Handle("/update_notify_props", ApiUserRequired(updateNotifyProps)).Methods("POST")
 	sr.Handle("/{id:[A-Za-z0-9]+}/", ApiUserRequiredActivity(getChannel, false)).Methods("GET")
 	sr.Handle("/{id:[A-Za-z0-9]+}/extra_info", ApiUserRequired(getChannelExtraInfo)).Methods("GET")
@@ -210,6 +211,7 @@ func updateChannel(c *Context, w http.ResponseWriter, r *http.Request) {
 		}
 
 		oldChannel.Header = channel.Header
+		oldChannel.Purpose = channel.Purpose
 
 		if len(channel.DisplayName) > 0 {
 			oldChannel.DisplayName = channel.DisplayName
@@ -277,6 +279,49 @@ func updateChannelHeader(c *Context, w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+func updateChannelPurpose(c *Context, w http.ResponseWriter, r *http.Request) {
+	props := model.MapFromJson(r.Body)
+	channelId := props["channel_id"]
+	if len(channelId) != 26 {
+		c.SetInvalidParam("updateChannelPurpose", "channel_id")
+		return
+	}
+
+	channelPurpose := props["channel_purpose"]
+	if len(channelPurpose) > 1024 {
+		c.SetInvalidParam("updateChannelPurpose", "channel_purpose")
+		return
+	}
+
+	sc := Srv.Store.Channel().Get(channelId)
+	cmc := Srv.Store.Channel().GetMember(channelId, c.Session.UserId)
+
+	if cresult := <-sc; cresult.Err != nil {
+		c.Err = cresult.Err
+		return
+	} else if cmcresult := <-cmc; cmcresult.Err != nil {
+		c.Err = cmcresult.Err
+		return
+	} else {
+		channel := cresult.Data.(*model.Channel)
+		// Don't need to do anything channel member, just wanted to confirm it exists
+
+		if !c.HasPermissionsToTeam(channel.TeamId, "updateChannelPurpose") {
+			return
+		}
+
+		channel.Purpose = channelPurpose
+
+		if ucresult := <-Srv.Store.Channel().Update(channel); ucresult.Err != nil {
+			c.Err = ucresult.Err
+			return
+		} else {
+			c.LogAudit("name=" + channel.Name)
+			w.Write([]byte(channel.ToJson()))
+		}
+	}
+}
+
 func getChannels(c *Context, w http.ResponseWriter, r *http.Request) {
 
 	// user is already in the team

api/channel_test.go

@@ -8,6 +8,7 @@ import (
 	"github.com/mattermost/platform/store"
 	"github.com/mattermost/platform/utils"
 	"net/http"
+	"strings"
 	"testing"
 	"time"
 )
@@ -174,13 +175,18 @@ func TestUpdateChannel(t *testing.T) {
 	Client.AddChannelMember(channel1.Id, userTeamAdmin.Id)
 
 	header := "a" + model.NewId() + "a"
-	upChannel1 := &model.Channel{Id: channel1.Id, Header: header}
+	purpose := "a" + model.NewId() + "a"
+	upChannel1 := &model.Channel{Id: channel1.Id, Header: header, Purpose: purpose}
 	upChannel1 = Client.Must(Client.UpdateChannel(upChannel1)).Data.(*model.Channel)
 
 	if upChannel1.Header != header {
 		t.Fatal("Channel admin failed to update header")
 	}
 
+	if upChannel1.Purpose != purpose {
+		t.Fatal("Channel admin failed to update purpose")
+	}
+
 	if upChannel1.DisplayName != channel1.DisplayName {
 		t.Fatal("Channel admin failed to skip displayName")
 	}
@@ -188,13 +194,18 @@ func TestUpdateChannel(t *testing.T) {
 	Client.LoginByEmail(team.Name, userTeamAdmin.Email, "pwd")
 
 	header = "b" + model.NewId() + "b"
-	upChannel1 = &model.Channel{Id: channel1.Id, Header: header}
+	purpose = "b" + model.NewId() + "b"
+	upChannel1 = &model.Channel{Id: channel1.Id, Header: header, Purpose: purpose}
 	upChannel1 = Client.Must(Client.UpdateChannel(upChannel1)).Data.(*model.Channel)
 
 	if upChannel1.Header != header {
 		t.Fatal("Team admin failed to update header")
 	}
 
+	if upChannel1.Purpose != purpose {
+		t.Fatal("Team admin failed to update purpose")
+	}
+
 	if upChannel1.DisplayName != channel1.DisplayName {
 		t.Fatal("Team admin failed to skip displayName")
 	}
@@ -259,10 +270,7 @@ func TestUpdateChannelHeader(t *testing.T) {
 	}
 
 	data["channel_id"] = channel1.Id
-	data["channel_header"] = ""
+	data["channel_header"] = strings.Repeat("a", 1050)
-	for i := 0; i < 1050; i++ {
-		data["channel_header"] += "a"
-	}
 	if _, err := Client.UpdateChannelHeader(data); err == nil {
 		t.Fatal("should have errored on bad channel header")
 	}
@@ -280,6 +288,65 @@ func TestUpdateChannelHeader(t *testing.T) {
 	}
 }
 
+func TestUpdateChannelPurpose(t *testing.T) {
+	Setup()
+
+	team := &model.Team{DisplayName: "Name", Name: "z-z-" + model.NewId() + "a", Email: "test@nowhere.com", Type: model.TEAM_OPEN}
+	team = Client.Must(Client.CreateTeam(team)).Data.(*model.Team)
+
+	user := &model.User{TeamId: team.Id, Email: model.NewId() + "corey@test.com", Nickname: "Corey Hulen", Password: "pwd"}
+	user = Client.Must(Client.CreateUser(user, "")).Data.(*model.User)
+	store.Must(Srv.Store.User().VerifyEmail(user.Id))
+
+	Client.LoginByEmail(team.Name, user.Email, "pwd")
+
+	channel1 := &model.Channel{DisplayName: "A Test API Name", Name: "a" + model.NewId() + "a", Type: model.CHANNEL_OPEN, TeamId: team.Id}
+	channel1 = Client.Must(Client.CreateChannel(channel1)).Data.(*model.Channel)
+
+	data := make(map[string]string)
+	data["channel_id"] = channel1.Id
+	data["channel_purpose"] = "new purpose"
+
+	var upChannel1 *model.Channel
+	if result, err := Client.UpdateChannelPurpose(data); err != nil {
+		t.Fatal(err)
+	} else {
+		upChannel1 = result.Data.(*model.Channel)
+	}
+
+	if upChannel1.Purpose != data["channel_purpose"] {
+		t.Fatal("Failed to update purpose")
+	}
+
+	data["channel_id"] = "junk"
+	if _, err := Client.UpdateChannelPurpose(data); err == nil {
+		t.Fatal("should have errored on junk channel id")
+	}
+
+	data["channel_id"] = "12345678901234567890123456"
+	if _, err := Client.UpdateChannelPurpose(data); err == nil {
+		t.Fatal("should have errored on non-existent channel id")
+	}
+
+	data["channel_id"] = channel1.Id
+	data["channel_purpose"] = strings.Repeat("a", 150)
+	if _, err := Client.UpdateChannelPurpose(data); err == nil {
+		t.Fatal("should have errored on bad channel purpose")
+	}
+
+	user2 := &model.User{TeamId: team.Id, Email: model.NewId() + "corey@test.com", Nickname: "Corey Hulen", Password: "pwd"}
+	user2 = Client.Must(Client.CreateUser(user2, "")).Data.(*model.User)
+	store.Must(Srv.Store.User().VerifyEmail(user2.Id))
+
+	Client.LoginByEmail(team.Name, user2.Email, "pwd")
+
+	data["channel_id"] = channel1.Id
+	data["channel_purpose"] = "new purpose"
+	if _, err := Client.UpdateChannelPurpose(data); err == nil {
+		t.Fatal("should have errored non-channel member trying to update purpose")
+	}
+}
+
 func TestGetChannel(t *testing.T) {
 	Setup()
 

api/slackimport.go

@@ -182,7 +182,7 @@ func SlackAddChannels(teamId string, slackchannels []SlackChannel, posts map[str
 			Type:        model.CHANNEL_OPEN,
 			DisplayName: sChannel.Name,
 			Name:        SlackConvertChannelName(sChannel.Name),
-			//Purpose:      sChannel.Topic["value"], // TODO uncomment this once Channel.Purpose is a field
+			Purpose:     sChannel.Topic["value"],
 		}
 		mChannel := ImportChannel(&newChannel)
 		if mChannel == nil {

model/channel.go

@@ -25,6 +25,7 @@ type Channel struct {
 	DisplayName   string `json:"display_name"`
 	Name          string `json:"name"`
 	Header        string `json:"header"`
+	Purpose       string `json:"purpose"`
 	LastPostAt    int64  `json:"last_post_at"`
 	TotalMsgCount int64  `json:"total_msg_count"`
 	ExtraUpdateAt int64  `json:"extra_update_at"`
@@ -93,6 +94,10 @@ func (o *Channel) IsValid() *AppError {
 		return NewAppError("Channel.IsValid", "Invalid header", "id="+o.Id)
 	}
 
+	if len(o.Purpose) > 128 {
+		return NewAppError("Channel.IsValid", "Invalid purpose", "id="+o.Id)
+	}
+
 	if len(o.CreatorId) > 26 {
 		return NewAppError("Channel.IsValid", "Invalid creator id", "")
 	}

model/channel_test.go

@@ -67,6 +67,26 @@ func TestChannelIsValid(t *testing.T) {
 	if err := o.IsValid(); err != nil {
 		t.Fatal(err)
 	}
+
+	o.Header = strings.Repeat("01234567890", 100)
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.Header = "1234"
+	if err := o.IsValid(); err != nil {
+		t.Fatal(err)
+	}
+
+	o.Purpose = strings.Repeat("01234567890", 20)
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.Purpose = "1234"
+	if err := o.IsValid(); err != nil {
+		t.Fatal(err)
+	}
 }
 
 func TestChannelPreSave(t *testing.T) {

model/client.go

@@ -452,6 +452,15 @@ func (c *Client) UpdateChannelHeader(data map[string]string) (*Result, *AppError
 	}
 }
 
+func (c *Client) UpdateChannelPurpose(data map[string]string) (*Result, *AppError) {
+	if r, err := c.DoApiPost("/channels/update_purpose", MapToJson(data)); err != nil {
+		return nil, err
+	} else {
+		return &Result{r.Header.Get(HEADER_REQUEST_ID),
+			r.Header.Get(HEADER_ETAG_SERVER), ChannelFromJson(r.Body)}, nil
+	}
+}
+
 func (c *Client) UpdateNotifyProps(data map[string]string) (*Result, *AppError) {
 	if r, err := c.DoApiPost("/channels/update_notify_props", MapToJson(data)); err != nil {
 		return nil, err

store/sql_channel_store.go

@@ -26,6 +26,7 @@ func NewSqlChannelStore(sqlStore *SqlStore) ChannelStore {
 		table.ColMap("Name").SetMaxSize(64)
 		table.SetUniqueTogether("Name", "TeamId")
 		table.ColMap("Header").SetMaxSize(1024)
+		table.ColMap("Purpose").SetMaxSize(128)
 		table.ColMap("CreatorId").SetMaxSize(26)
 
 		tablem := db.AddTableWithName(model.ChannelMember{}, "ChannelMembers").SetKeys(false, "ChannelId", "UserId")
@@ -86,6 +87,7 @@ func (s SqlChannelStore) UpgradeSchemaIfNeeded() {
 
 	// BEGIN REMOVE AFTER 1.2.0
 	s.RenameColumnIfExists("Channels", "Description", "Header", "varchar(1024)")
+	s.CreateColumnIfNotExists("Channels", "Purpose", "varchar(1024)", "varchar(1024)", "")
 	// END REMOVE AFTER 1.2.0
 }