Skip to content

Commit 3df1485

Browse files
chetanyakanchetanyakan
authored
Merge pull request #1 from Brightscout/MI-367
MI-367: Add configurable settings to disable direct messages and group chats
2 parents 26f595e + a878ebb commit 3df1485

10 files changed

+686
-0
lines changed

‎.editorconfig

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# http://editorconfig.org/
2+
3+
root = true
4+
5+
[*]
6+
end_of_line = lf
7+
insert_final_newline = true
8+
trim_trailing_whitespace = true
9+
charset = utf-8
10+
11+
[*.go]
12+
indent_style = tab
13+
14+
[*.{js,jsx,json,html}]
15+
indent_style = space
16+
indent_size = 4
17+
18+
[webapp/package.json]
19+
indent_size = 2
20+
21+
[webapp/.eslintrc.json]
22+
indent_size = 2
23+
24+
[Makefile]
25+
indent_style = tab
26+
27+
[*.scss]
28+
indent_style = space
29+
indent_size = 4
30+
31+
[*.md]
32+
trim_trailing_whitespace = false
33+
indent_style = space

‎.gitignore

+64
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,67 @@
1010

1111
# Output of the go coverage tool, specifically when used with LiteIDE
1212
*.out
13+
14+
# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
15+
.glide/
16+
17+
# Logs
18+
logs
19+
npm-debug.log*
20+
yarn-debug.log*
21+
yarn-error.log*
22+
23+
# Runtime data
24+
pids
25+
*.pid
26+
*.seed
27+
*.pid.lock
28+
29+
# Directory for instrumented libs generated by jscoverage/JSCover
30+
lib-cov
31+
32+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
33+
.grunt
34+
35+
# Bower dependency directory (https://bower.io/)
36+
bower_components
37+
38+
# node-waf configuration
39+
.lock-wscript
40+
41+
# Compiled binary addons (https://nodejs.org/api/addons.html)
42+
build/Release
43+
44+
# Dependency directories
45+
node_modules/
46+
jspm_packages/
47+
48+
# Optional npm cache directory
49+
.npm
50+
51+
# Optional eslint cache
52+
.eslintcache
53+
54+
# Optional REPL history
55+
.node_repl_history
56+
57+
# Output of 'npm pack'
58+
*.tgz
59+
60+
# Yarn Integrity file
61+
.yarn-integrity
62+
63+
# dotenv environment variables file
64+
.env
65+
66+
# next.js build output
67+
.next
68+
69+
# Plugin generated files
70+
dist
71+
plugin.exe
72+
.npminstall
73+
*.tar.gz
74+
server/vendor/
75+
.history/
76+
coverage.txt

‎Makefile

+213
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,213 @@
1+
GO:=go
2+
GOARCH:=amd64
3+
GOOS=$(shell uname -s | tr '[:upper:]' '[:lower:]')
4+
GOPATH ?= $(GOPATH:)
5+
6+
MANIFEST_FILE ?= plugin.json
7+
8+
PLUGINNAME=$(shell echo `grep '"'"id"'"\s*:\s*"' $(MANIFEST_FILE) | head -1 | cut -d'"' -f4`)
9+
PLUGINVERSION=v$(shell echo `grep '"'"version"'"\s*:\s*"' $(MANIFEST_FILE) | head -1 | cut -d'"' -f4`)
10+
PACKAGENAME=mattermost-plugin-$(PLUGINNAME)-$(PLUGINVERSION)
11+
12+
HAS_WEBAPP=$(shell if [ "$(shell grep -E '[\^"]webapp["][ ]*[:]' $(MANIFEST_FILE) | wc -l)" -gt "0" ]; then echo "true"; fi)
13+
HAS_SERVER=$(shell if [ "$(shell grep -E '[\^"]server["][ ]*[:]' $(MANIFEST_FILE) | wc -l)" -gt "0" ]; then echo "true"; fi)
14+
15+
TMPFILEGOLINT=golint.tmp
16+
17+
BLACK=`tput setaf 0`
18+
RED=`tput setaf 1`
19+
GREEN=`tput setaf 2`
20+
YELLOW=`tput setaf 3`
21+
BLUE=`tput setaf 4`
22+
MAGENTA=`tput setaf 5`
23+
CYAN=`tput setaf 6`
24+
WHITE=`tput setaf 7`
25+
26+
BOLD=`tput bold`
27+
INVERSE=`tput rev`
28+
RESET=`tput sgr0`
29+
30+
.PHONY: default .npminstall vendor setup-plugin build test clean check-style check-js check-go govet golint gofmt .distclean dist format fix-js fix-go trigger-release install-dependencies
31+
32+
default: dist
33+
34+
setup-plugin:
35+
ifneq ($(HAS_WEBAPP),)
36+
@echo "export const PLUGIN_NAME = '`echo $(PLUGINNAME)`';" > webapp/src/constants/manifest.js
37+
endif
38+
ifneq ($(HAS_SERVER),)
39+
@echo "package config\n\nconst (\n\tPluginName = \""`echo $(PLUGINNAME)`"\"\n)" > server/config/manifest.go
40+
endif
41+
42+
trigger-release:
43+
@if [ $$(git status --porcelain | wc -l) != "0" -o $$(git rev-list HEAD@{upstream}..HEAD | wc -l) != "0" ]; \
44+
then echo ${RED}"local repo is not clean"${RESET}; exit 1; fi;
45+
@echo ${BOLD}"Creating a tag to trigger circleci build-and-release job\n"${RESET}
46+
git tag $(PLUGINVERSION)
47+
git push origin $(PLUGINVERSION)
48+
49+
check-style: check-js check-go
50+
51+
check-js:
52+
ifneq ($(HAS_WEBAPP),)
53+
@echo ${BOLD}Running ESLINT${RESET}
54+
@cd webapp && npm run lint
55+
@echo ${GREEN}"eslint success\n"${RESET}
56+
endif
57+
58+
check-go: govet golint gofmt
59+
60+
govet:
61+
ifneq ($(HAS_SERVER),)
62+
@go tool vet 2>/dev/null ; if [ $$? -eq 3 ]; then \
63+
echo "--> installing govet"; \
64+
go get golang.org/x/tools/cmd/vet; \
65+
fi
66+
@echo ${BOLD}Running GOVET${RESET}
67+
@cd server
68+
$(eval PKGS := $(shell go list ./... | grep -v /vendor/))
69+
@$(GO) vet -shadow $(PKGS)
70+
@echo ${GREEN}"govet success\n"${RESET}
71+
endif
72+
73+
golint:
74+
ifneq ($(HAS_SERVER),)
75+
@command -v golint >/dev/null ; if [ $$? -ne 0 ]; then \
76+
echo "--> installing golint"; \
77+
go get -u golang.org/x/lint/golint; \
78+
fi
79+
@echo ${BOLD}Running GOLINT${RESET}
80+
@cd server
81+
$(eval PKGS := $(shell go list ./... | grep -v /vendor/))
82+
@touch $(TMPFILEGOLINT)
83+
-@for pkg in $(PKGS) ; do \
84+
echo `golint $$pkg | grep -v "have comment" | grep -v "comment on exported" | grep -v "lint suggestions"` >> $(TMPFILEGOLINT) ; \
85+
done
86+
@grep -Ev "^$$" $(TMPFILEGOLINT) || true
87+
@if [ "$$(grep -Ev "^$$" $(TMPFILEGOLINT) | wc -l)" -gt "0" ]; then \
88+
rm -f $(TMPFILEGOLINT); echo ${RED}"golint failure\n"${RESET}; exit 1; else \
89+
rm -f $(TMPFILEGOLINT); echo ${GREEN}"golint success\n"${RESET}; \
90+
fi
91+
endif
92+
93+
format: fix-js fix-go
94+
95+
fix-js:
96+
ifneq ($(HAS_WEBAPP),)
97+
@echo ${BOLD}Formatting js giles${RESET}
98+
@cd webapp && npm run fix
99+
@echo "formatted js files\n"
100+
endif
101+
102+
fix-go:
103+
ifneq ($(HAS_SERVER),)
104+
@command -v goimports >/dev/null ; if [ $$? -ne 0 ]; then \
105+
echo "--> installing goimports"; \
106+
go get golang.org/x/tools/cmd/goimports; \
107+
fi
108+
@echo ${BOLD}Formatting go giles${RESET}
109+
@cd server
110+
@find ./ -type f -name "*.go" -not -path "./server/vendor/*" -exec goimports -w {} \;
111+
@echo "formatted go files\n"
112+
endif
113+
114+
gofmt:
115+
ifneq ($(HAS_SERVER),)
116+
@echo ${BOLD}Running GOFMT${RESET}
117+
@for package in $$(go list ./server/...); do \
118+
files=$$(go list -f '{{range .GoFiles}}{{$$.Dir}}/{{.}} {{end}}' $$package); \
119+
if [ "$$files" ]; then \
120+
gofmt_output=$$(gofmt -d -s $$files 2>&1); \
121+
if [ "$$gofmt_output" ]; then \
122+
echo "$$gofmt_output"; \
123+
echo ${RED}"gofmt failure\n"${RESET}; \
124+
exit 1; \
125+
fi; \
126+
fi; \
127+
done
128+
@echo ${GREEN}"gofmt success\n"${RESET}
129+
endif
130+
131+
test:
132+
ifneq ($(HAS_SERVER),)
133+
go test -v -coverprofile=coverage.txt ./...
134+
endif
135+
136+
.npminstall:
137+
ifneq ($(HAS_WEBAPP),)
138+
@echo ${BOLD}"Getting dependencies using npm\n"${RESET}
139+
cd webapp && npm install
140+
@echo "\n"
141+
endif
142+
143+
vendor:
144+
ifneq ($(HAS_SERVER),)
145+
@echo ${BOLD}"Getting dependencies using glide\n"${RESET}
146+
cd server && go get github.com/Masterminds/glide
147+
cd server && $(shell go env GOPATH)/bin/glide install
148+
@echo "\n"
149+
endif
150+
151+
install-dependencies: .npminstall vendor
152+
153+
dist: install-dependencies check-style test build
154+
155+
build: .distclean $(MANIFEST_FILE)
156+
@echo ${BOLD}"Building plugin\n"${RESET}
157+
mkdir -p dist/$(PLUGINNAME)/
158+
cp $(MANIFEST_FILE) dist/$(PLUGINNAME)/
159+
160+
ifneq ($(HAS_WEBAPP),)
161+
# Build and copy files from webapp
162+
cd webapp && npm run build
163+
mkdir -p dist/$(PLUGINNAME)/webapp
164+
cp -r webapp/dist/* dist/$(PLUGINNAME)/webapp/
165+
endif
166+
167+
ifneq ($(HAS_SERVER),)
168+
# Build files from server and copy server executables
169+
cd server && go get github.com/mitchellh/gox
170+
$(shell go env GOPATH)/bin/gox -osarch='darwin/amd64 linux/amd64 windows/amd64' -output 'dist/intermediate/plugin_{{.OS}}_{{.Arch}}' ./server
171+
mkdir -p dist/$(PLUGINNAME)/server
172+
173+
endif
174+
175+
# Compress plugin
176+
ifneq ($(HAS_SERVER),)
177+
mv dist/intermediate/plugin_darwin_amd64 dist/$(PLUGINNAME)/server/plugin.exe
178+
cd dist && tar -zcvf $(PACKAGENAME)-darwin-amd64.tar.gz $(PLUGINNAME)/*
179+
180+
mv dist/intermediate/plugin_linux_amd64 dist/$(PLUGINNAME)/server/plugin.exe
181+
cd dist && tar -zcvf $(PACKAGENAME)-linux-amd64.tar.gz $(PLUGINNAME)/*
182+
183+
mv dist/intermediate/plugin_windows_amd64.exe dist/$(PLUGINNAME)/server/plugin.exe
184+
cd dist && tar -zcvf $(PACKAGENAME)-windows-amd64.tar.gz $(PLUGINNAME)/*
185+
else ifneq ($(HAS_WEBAPP),)
186+
cd dist && tar -zcvf $(PACKAGENAME).tar.gz $(PLUGINNAME)/*
187+
endif
188+
189+
# Clean up temp files
190+
rm -rf dist/$(PLUGINNAME)
191+
rm -rf dist/intermediate
192+
193+
ifneq ($(HAS_SERVER),)
194+
@echo Linux plugin built at: dist/$(PACKAGENAME)-linux-amd64.tar.gz
195+
@echo MacOS X plugin built at: dist/$(PACKAGENAME)-darwin-amd64.tar.gz
196+
@echo Windows plugin built at: dist/$(PACKAGENAME)-windows-amd64.tar.gz
197+
else ifneq ($(HAS_WEBAPP),)
198+
@echo Cross-platform plugin built at: dist/$(PACKAGENAME)-amd64.tar.gz
199+
endif
200+
201+
.distclean:
202+
@echo ${BOLD}"Cleaning dist files\n"${RESET}
203+
rm -rf dist
204+
rm -rf webapp/dist
205+
rm -f server/plugin.exe
206+
@echo "\n"
207+
208+
clean: .distclean
209+
@echo ${BOLD}"Cleaning plugin\n"${RESET}
210+
rm -rf server/vendor
211+
rm -rf webapp/node_modules
212+
rm -rf webapp/.npminstall
213+
@echo "\n"

‎README.md

+41
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
11
# mattermost-plugin-disable-dm
22
A mattermost plugin to disable direct messages and group chats.
3+
4+
## Installation and setup
5+
#### Platform & tools
6+
- Make sure you have following components installed:
7+
8+
* Go - v1.11 - https://golang.org/doc/install
9+
> **Note:** If you have installed Go to a custom location, make sure the $GOROOT variable is set properly. Refer [Installing to a custom location](https://golang.org/doc/install#install).
10+
11+
* NodeJS - v10.11 and NPM - v6.4.1 - https://docs.npmjs.com/getting-started/installing-node
12+
13+
* Make
14+
15+
16+
## Building the plugins
17+
- Run the following commands to prepare a compiled, distributable plugin zip:
18+
19+
```
20+
$ mkdir -p ${GOPATH}/src/github.com/Brightscout
21+
$ cd ${GOPATH}/src/github.com/Brightscout
22+
$ git clone [email protected]:Brightscout/mattermost-plugin-disable-dm.git
23+
$ cd mattermost-plugin-disable-dm
24+
$ make dist
25+
```
26+
27+
28+
- This will produce three tar.gz files in `/dist ` directory corresponding to various platforms:
29+
30+
| Flavor | Distribution |
31+
|-------- | ------------ |
32+
| Linux | `mattermost-plugin-disable-dm-v<X.Y.Z>-linux-amd64.tar.gz` |
33+
| MacOS | `mattermost-plugin-disable-dm-v<X.Y.Z>-darwin-amd64.tar.gz` |
34+
| Windows | `mattermost-plugin-disable-dm-v<X.Y.Z>-windows-amd64.tar.gz` |
35+
36+
This will also install, **Glide** - the Go package manager.
37+
38+
## Install the plugin to Mattermost
39+
- Make sure that the plugin uploads are enabled in `PluginSettings.EnableUploads` in your `config.json` file.
40+
- Go to **System Console > Plugins (Beta) > Management** and set `Enable Plugins` to `true`.
41+
- From **System Console > Plugins (Beta) > Management**, upload the plugin generated above based on the OS of your Mattermost server.
42+
- Once installed, open **System Console > Plugins (Beta) > Team Membership** in left-hand sidebar and configure the plugin settings.
43+
- Enable the plugin from **System Console > Plugins (Beta) > Management**.

‎plugin.json

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"id": "disable-dm",
3+
"version": "1.0.0",
4+
"name": "Disable DM",
5+
"description": "A Mattermost plugin to disable direct messages and group chats.",
6+
"server": {
7+
"executable": "server/plugin.exe"
8+
},
9+
"settings_schema": {
10+
"settings": [
11+
{
12+
"key": "RejectDMs",
13+
"display_name": "Reject DMs:",
14+
"type": "bool",
15+
"default": true,
16+
"help_text": "If set the plugin will reject direct messages."
17+
},
18+
{
19+
"key": "RejectGroupChats",
20+
"display_name": "Reject Group Chats:",
21+
"type": "bool",
22+
"default": true,
23+
"help_text": "If set the plugin will reject messages sent to group chats."
24+
},
25+
{
26+
"key": "RejectionMessage",
27+
"display_name": "Rejection Message:",
28+
"type": "text",
29+
"help_text": "Enter the message to display to users who try to send a direct message.",
30+
"default": "Direct messages have been disabled by an administrator."
31+
}
32+
],
33+
"header": "",
34+
"footer": ""
35+
}
36+
}

0 commit comments

Comments
 (0)