users_controller.rb 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029
  1. # Copyright (C) 2012-2016 Zammad Foundation, http://zammad-foundation.org/
  2. class UsersController < ApplicationController
  3. prepend_before_action :authentication_check, except: [:create, :password_reset_send, :password_reset_verify, :image]
  4. prepend_before_action :authentication_check_only, only: [:create]
  5. # @path [GET] /users
  6. #
  7. # @summary Returns a list of User records.
  8. # @notes The requester has to be in the role 'Admin' or 'Agent' to
  9. # get a list of all Users. If the requester is in the
  10. # role 'Customer' only just the own User record will be returned.
  11. #
  12. # @response_message 200 [Array<User>] List of matching User records.
  13. # @response_message 401 Invalid session.
  14. def index
  15. offset = 0
  16. per_page = 500
  17. if params[:page] && params[:per_page]
  18. offset = (params[:page].to_i - 1) * params[:per_page].to_i
  19. per_page = params[:per_page].to_i
  20. end
  21. if per_page > 500
  22. per_page = 500
  23. end
  24. # only allow customer to fetch him self
  25. users = if !current_user.permissions?(['admin.user', 'ticket.agent'])
  26. User.where(id: current_user.id).order(id: 'ASC').offset(offset).limit(per_page)
  27. else
  28. User.all.order(id: 'ASC').offset(offset).limit(per_page)
  29. end
  30. if params[:expand]
  31. list = []
  32. users.each { |user|
  33. list.push user.attributes_with_association_names
  34. }
  35. render json: list, status: :ok
  36. return
  37. end
  38. if params[:full]
  39. assets = {}
  40. item_ids = []
  41. users.each { |item|
  42. item_ids.push item.id
  43. assets = item.assets(assets)
  44. }
  45. render json: {
  46. record_ids: item_ids,
  47. assets: assets,
  48. }, status: :ok
  49. return
  50. end
  51. users_all = []
  52. users.each { |user|
  53. users_all.push User.lookup(id: user.id).attributes_with_association_ids
  54. }
  55. render json: users_all, status: :ok
  56. end
  57. # @path [GET] /users/{id}
  58. #
  59. # @summary Returns the User record with the requested identifier.
  60. # @notes The requester has to be in the role 'Admin' or 'Agent' to
  61. # access all User records. If the requester is in the
  62. # role 'Customer' just the own User record is accessable.
  63. #
  64. # @parameter id(required) [Integer] The identifier matching the requested User.
  65. # @parameter full [Bool] If set a Asset structure with all connected Assets gets returned.
  66. #
  67. # @response_message 200 [User] User record matching the requested identifier.
  68. # @response_message 401 Invalid session.
  69. def show
  70. user = User.find(params[:id])
  71. access!(user, 'read')
  72. if params[:expand]
  73. result = user.attributes_with_association_names
  74. elsif params[:full]
  75. result = {
  76. id: params[:id],
  77. assets: user.assets({}),
  78. }
  79. else
  80. result = user.attributes_with_association_ids
  81. result.delete('password')
  82. end
  83. render json: result
  84. end
  85. # @path [POST] /users
  86. #
  87. # @summary Creates a User record with the provided attribute values.
  88. # @notes TODO.
  89. #
  90. # @parameter User(required,body) [User] The attribute value structure needed to create a User record.
  91. #
  92. # @response_message 200 [User] Created User record.
  93. # @response_message 401 Invalid session.
  94. def create
  95. clean_params = User.association_name_to_id_convert(params)
  96. clean_params = User.param_cleanup(clean_params, true)
  97. # check if it's first user, the admin user
  98. # inital admin account
  99. count = User.all.count()
  100. admin_account_exists = true
  101. if count <= 2
  102. admin_account_exists = false
  103. end
  104. # if it's a signup, add user to customer role
  105. if !current_user
  106. # check if feature is enabled
  107. if admin_account_exists && !Setting.get('user_create_account')
  108. raise Exceptions::UnprocessableEntity, 'Feature not enabled!'
  109. end
  110. # check signup option only after admin account is created
  111. if admin_account_exists && !params[:signup]
  112. raise Exceptions::UnprocessableEntity, 'Only signup with not authenticate user possible!'
  113. end
  114. user = User.new(clean_params)
  115. user.associations_from_param(params)
  116. user.updated_by_id = 1
  117. user.created_by_id = 1
  118. # add first user as admin/agent and to all groups
  119. group_ids = []
  120. role_ids = []
  121. if count <= 2
  122. Role.where(name: %w(Admin Agent)).each { |role|
  123. role_ids.push role.id
  124. }
  125. Group.all().each { |group|
  126. group_ids.push group.id
  127. }
  128. # everybody else will go as customer per default
  129. else
  130. role_ids = Role.signup_role_ids
  131. end
  132. user.role_ids = role_ids
  133. user.group_ids = group_ids
  134. # remember source (in case show email verify banner)
  135. # if not inital user creation
  136. if admin_account_exists
  137. user.source = 'signup'
  138. end
  139. # else do assignment as defined
  140. else
  141. # permission check
  142. permission_check_by_permission(params)
  143. user = User.new(clean_params)
  144. user.associations_from_param(params)
  145. end
  146. # check if user already exists
  147. if !user.email.empty?
  148. exists = User.where(email: user.email.downcase).first
  149. raise Exceptions::UnprocessableEntity, 'User already exists!' if exists
  150. end
  151. user.save!
  152. # if first user was added, set system init done
  153. if !admin_account_exists
  154. Setting.set('system_init_done', true)
  155. # fetch org logo
  156. if !user.email.empty?
  157. Service::Image.organization_suggest(user.email)
  158. end
  159. # load calendar
  160. Calendar.init_setup(request.remote_ip)
  161. # load text modules
  162. begin
  163. TextModule.load(request.env['HTTP_ACCEPT_LANGUAGE'] || 'en-us')
  164. rescue => e
  165. logger.error "Unable to load text modules #{request.env['HTTP_ACCEPT_LANGUAGE'] || 'en-us'}: #{e.message}"
  166. end
  167. end
  168. # send inviteation if needed / only if session exists
  169. if params[:invite] && current_user
  170. token = Token.create(action: 'PasswordReset', user_id: user.id)
  171. NotificationFactory::Mailer.notification(
  172. template: 'user_invite',
  173. user: user,
  174. objects: {
  175. token: token,
  176. user: user,
  177. current_user: current_user,
  178. }
  179. )
  180. end
  181. # send email verify
  182. if params[:signup] && !current_user
  183. result = User.signup_new_token(user)
  184. NotificationFactory::Mailer.notification(
  185. template: 'signup',
  186. user: user,
  187. objects: result,
  188. )
  189. end
  190. if params[:expand]
  191. user = User.find(user.id).attributes_with_association_names
  192. render json: user, status: :created
  193. return
  194. end
  195. user_new = User.find(user.id).attributes_with_association_ids
  196. user_new.delete('password')
  197. render json: user_new, status: :created
  198. end
  199. # @path [PUT] /users/{id}
  200. #
  201. # @summary Updates the User record matching the identifier with the provided attribute values.
  202. # @notes TODO.
  203. #
  204. # @parameter id(required) [Integer] The identifier matching the requested User record.
  205. # @parameter User(required,body) [User] The attribute value structure needed to update a User record.
  206. #
  207. # @response_message 200 [User] Updated User record.
  208. # @response_message 401 Invalid session.
  209. def update
  210. permission_check_by_permission(params)
  211. user = User.find(params[:id])
  212. access!(user, 'change')
  213. # permission check
  214. permission_check_by_permission(params)
  215. user.with_lock do
  216. clean_params = User.association_name_to_id_convert(params)
  217. clean_params = User.param_cleanup(clean_params, true)
  218. user.update_attributes(clean_params)
  219. # only allow Admin's
  220. if current_user.permissions?('admin.user') && (params[:role_ids] || params[:roles])
  221. user.associations_from_param({ role_ids: params[:role_ids], roles: params[:roles] })
  222. end
  223. # only allow Admin's
  224. if current_user.permissions?('admin.user') && (params[:group_ids] || params[:groups])
  225. user.associations_from_param({ group_ids: params[:group_ids], groups: params[:groups] })
  226. end
  227. # only allow Admin's and Agent's
  228. if current_user.permissions?(['admin.user', 'ticket.agent']) && (params[:organization_ids] || params[:organizations])
  229. user.associations_from_param({ organization_ids: params[:organization_ids], organizations: params[:organizations] })
  230. end
  231. if params[:expand]
  232. user = User.find(user.id).attributes_with_association_names
  233. render json: user, status: :ok
  234. return
  235. end
  236. end
  237. # get new data
  238. user_new = User.find(user.id).attributes_with_association_ids
  239. user_new.delete('password')
  240. render json: user_new, status: :ok
  241. end
  242. # @path [DELETE] /users/{id}
  243. #
  244. # @summary Deletes the User record matching the given identifier.
  245. # @notes The requester has to be in the role 'Admin' to be able to delete a User record.
  246. #
  247. # @parameter id(required) [User] The identifier matching the requested User record.
  248. #
  249. # @response_message 200 User successfully deleted.
  250. # @response_message 401 Invalid session.
  251. def destroy
  252. user = User.find(params[:id])
  253. access!(user, 'delete')
  254. model_references_check(User, params)
  255. model_destroy_render(User, params)
  256. end
  257. # @path [GET] /users/me
  258. #
  259. # @summary Returns the User record of current user.
  260. # @notes The requestor need to have a valid authentication.
  261. #
  262. # @parameter full [Bool] If set a Asset structure with all connected Assets gets returned.
  263. #
  264. # @response_message 200 [User] User record matching the requested identifier.
  265. # @response_message 401 Invalid session.
  266. def me
  267. if params[:expand]
  268. user = current_user.attributes_with_association_names
  269. render json: user, status: :ok
  270. return
  271. end
  272. if params[:full]
  273. full = User.full(current_user.id)
  274. render json: full
  275. return
  276. end
  277. user = current_user.attributes_with_association_ids
  278. user.delete('password')
  279. render json: user
  280. end
  281. # @path [GET] /users/search
  282. #
  283. # @tag Search
  284. # @tag User
  285. #
  286. # @summary Searches the User matching the given expression(s).
  287. # @notes TODO: It's possible to use the SOLR search syntax.
  288. # The requester has to be in the role 'Admin' or 'Agent' to
  289. # be able to search for User records.
  290. #
  291. # @parameter query [String] The search query.
  292. # @parameter limit [Integer] The limit of search results.
  293. # @parameter role_ids(multi) [Array<String>] A list of Role identifiers to which the Users have to be allocated to.
  294. # @parameter full [Boolean] Defines if the result should be
  295. # true: { user_ids => [1,2,...], assets => {...} }
  296. # or false: [{:id => user.id, :label => "firstname lastname <email>", :value => "firstname lastname <email>"},...].
  297. #
  298. # @response_message 200 [Array<User>] A list of User records matching the search term.
  299. # @response_message 401 Invalid session.
  300. def search
  301. if !current_user.permissions?(['ticket.agent', 'admin.user'])
  302. response_access_deny
  303. return
  304. end
  305. # set limit for pagination if needed
  306. if params[:page] && params[:per_page]
  307. params[:limit] = params[:page].to_i * params[:per_page].to_i
  308. end
  309. if params[:limit] && params[:limit].to_i > 500
  310. params[:limit].to_i = 500
  311. end
  312. query_params = {
  313. query: params[:query],
  314. limit: params[:limit],
  315. current_user: current_user,
  316. }
  317. if params[:role_ids] && !params[:role_ids].empty?
  318. query_params[:role_ids] = params[:role_ids]
  319. end
  320. # do query
  321. user_all = User.search(query_params)
  322. # do pagination if needed
  323. if params[:page] && params[:per_page]
  324. offset = (params[:page].to_i - 1) * params[:per_page].to_i
  325. user_all = user_all.slice(offset, params[:per_page].to_i) || []
  326. end
  327. if params[:expand]
  328. list = []
  329. user_all.each { |user|
  330. list.push user.attributes_with_association_names
  331. }
  332. render json: list, status: :ok
  333. return
  334. end
  335. # build result list
  336. if params[:label]
  337. users = []
  338. user_all.each { |user|
  339. realname = user.firstname.to_s + ' ' + user.lastname.to_s
  340. if user.email && user.email.to_s != ''
  341. realname = realname + ' <' + user.email.to_s + '>'
  342. end
  343. a = { id: user.id, label: realname, value: realname }
  344. users.push a
  345. }
  346. # return result
  347. render json: users
  348. return
  349. end
  350. if params[:full]
  351. user_ids = []
  352. assets = {}
  353. user_all.each { |user|
  354. assets = user.assets(assets)
  355. user_ids.push user.id
  356. }
  357. # return result
  358. render json: {
  359. assets: assets,
  360. user_ids: user_ids.uniq,
  361. }
  362. return
  363. end
  364. list = []
  365. user_all.each { |user|
  366. list.push user.attributes_with_association_ids
  367. }
  368. render json: list, status: :ok
  369. end
  370. # @path [GET] /users/recent
  371. #
  372. # @tag Search
  373. # @tag User
  374. #
  375. # @summary Recent creates Users.
  376. # @notes Recent creates Users.
  377. #
  378. # @parameter limit [Integer] The limit of search results.
  379. # @parameter role_ids(multi) [Array<String>] A list of Role identifiers to which the Users have to be allocated to.
  380. # @parameter full [Boolean] Defines if the result should be
  381. # true: { user_ids => [1,2,...], assets => {...} }
  382. # or false: [{:id => user.id, :label => "firstname lastname <email>", :value => "firstname lastname <email>"},...].
  383. #
  384. # @response_message 200 [Array<User>] A list of User records matching the search term.
  385. # @response_message 401 Invalid session.
  386. def recent
  387. if !current_user.permissions?('admin.user')
  388. response_access_deny
  389. return
  390. end
  391. # do query
  392. user_all = if params[:role_ids] && !params[:role_ids].empty?
  393. User.joins(:roles).where( 'roles.id' => params[:role_ids] ).where('users.id != 1').order('users.created_at DESC').limit( params[:limit] || 20 )
  394. else
  395. User.where('id != 1').order('created_at DESC').limit( params[:limit] || 20 )
  396. end
  397. # build result list
  398. if !params[:full]
  399. users = []
  400. user_all.each { |user|
  401. realname = user.firstname.to_s + ' ' + user.lastname.to_s
  402. if user.email && user.email.to_s != ''
  403. realname = realname + ' <' + user.email.to_s + '>'
  404. end
  405. a = { id: user.id, label: realname, value: realname }
  406. users.push a
  407. }
  408. # return result
  409. render json: users
  410. return
  411. end
  412. user_ids = []
  413. assets = {}
  414. user_all.each { |user|
  415. assets = user.assets(assets)
  416. user_ids.push user.id
  417. }
  418. # return result
  419. render json: {
  420. assets: assets,
  421. user_ids: user_ids.uniq,
  422. }
  423. end
  424. # @path [GET] /users/history/{id}
  425. #
  426. # @tag History
  427. # @tag User
  428. #
  429. # @summary Returns the History records of a User record matching the given identifier.
  430. # @notes The requester has to be in the role 'Admin' or 'Agent' to
  431. # get the History records of a User record.
  432. #
  433. # @parameter id(required) [Integer] The identifier matching the requested User record.
  434. #
  435. # @response_message 200 [History] The History records of the requested User record.
  436. # @response_message 401 Invalid session.
  437. def history
  438. # permission check
  439. if !current_user.permissions?(['admin.user', 'ticket.agent'])
  440. response_access_deny
  441. return
  442. end
  443. # get user data
  444. user = User.find(params[:id])
  445. # get history of user
  446. history = user.history_get(true)
  447. # return result
  448. render json: history
  449. end
  450. =begin
  451. Resource:
  452. POST /api/v1/users/email_verify
  453. Payload:
  454. {
  455. "token": "SoMeToKeN",
  456. }
  457. Response:
  458. {
  459. :message => 'ok'
  460. }
  461. Test:
  462. curl http://localhost/api/v1/users/email_verify.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"token": "SoMeToKeN"}'
  463. =end
  464. def email_verify
  465. raise Exceptions::UnprocessableEntity, 'No token!' if !params[:token]
  466. user = User.signup_verify_via_token(params[:token], current_user)
  467. raise Exceptions::UnprocessableEntity, 'Invalid token!' if !user
  468. render json: { message: 'ok', user_email: user.email }, status: :ok
  469. end
  470. =begin
  471. Resource:
  472. POST /api/v1/users/email_verify_send
  473. Payload:
  474. {
  475. "email": "some_email@example.com"
  476. }
  477. Response:
  478. {
  479. :message => 'ok'
  480. }
  481. Test:
  482. curl http://localhost/api/v1/users/email_verify_send.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"email": "some_email@example.com"}'
  483. =end
  484. def email_verify_send
  485. raise Exceptions::UnprocessableEntity, 'No email!' if !params[:email]
  486. # check is verify is possible to send
  487. user = User.find_by(email: params[:email].downcase)
  488. raise Exceptions::UnprocessableEntity, 'No such user!' if !user
  489. #if user.verified == true
  490. # render json: { error: 'Already verified!' }, status: :unprocessable_entity
  491. # return
  492. #end
  493. token = Token.create(action: 'Signup', user_id: user.id)
  494. result = User.signup_new_token(user)
  495. if result && result[:token]
  496. user = result[:user]
  497. NotificationFactory::Mailer.notification(
  498. template: 'signup',
  499. user: user,
  500. objects: result
  501. )
  502. # only if system is in develop mode, send token back to browser for browser tests
  503. if Setting.get('developer_mode') == true
  504. render json: { message: 'ok', token: result[:token].name }, status: :ok
  505. return
  506. end
  507. # token sent to user, send ok to browser
  508. render json: { message: 'ok' }, status: :ok
  509. return
  510. end
  511. # unable to generate token
  512. render json: { message: 'failed' }, status: :ok
  513. end
  514. =begin
  515. Resource:
  516. POST /api/v1/users/password_reset
  517. Payload:
  518. {
  519. "username": "some user name"
  520. }
  521. Response:
  522. {
  523. :message => 'ok'
  524. }
  525. Test:
  526. curl http://localhost/api/v1/users/password_reset.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"username": "some_username"}'
  527. =end
  528. def password_reset_send
  529. # check if feature is enabled
  530. raise Exceptions::UnprocessableEntity, 'Feature not enabled!' if !Setting.get('user_lost_password')
  531. result = User.password_reset_new_token(params[:username])
  532. if result && result[:token]
  533. # send mail
  534. user = result[:user]
  535. NotificationFactory::Mailer.notification(
  536. template: 'password_reset',
  537. user: user,
  538. objects: result
  539. )
  540. # only if system is in develop mode, send token back to browser for browser tests
  541. if Setting.get('developer_mode') == true
  542. render json: { message: 'ok', token: result[:token].name }, status: :ok
  543. return
  544. end
  545. # token sent to user, send ok to browser
  546. render json: { message: 'ok' }, status: :ok
  547. return
  548. end
  549. # unable to generate token
  550. render json: { message: 'failed' }, status: :ok
  551. end
  552. =begin
  553. Resource:
  554. POST /api/v1/users/password_reset_verify
  555. Payload:
  556. {
  557. "token": "SoMeToKeN",
  558. "password": "new_password"
  559. }
  560. Response:
  561. {
  562. :message => 'ok'
  563. }
  564. Test:
  565. curl http://localhost/api/v1/users/password_reset_verify.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"token": "SoMeToKeN", "password" "new_password"}'
  566. =end
  567. def password_reset_verify
  568. if params[:password]
  569. # check password policy
  570. result = password_policy(params[:password])
  571. if result != true
  572. render json: { message: 'failed', notice: result }, status: :ok
  573. return
  574. end
  575. # set new password with token
  576. user = User.password_reset_via_token(params[:token], params[:password])
  577. # send mail
  578. if user
  579. NotificationFactory::Mailer.notification(
  580. template: 'password_change',
  581. user: user,
  582. objects: {
  583. user: user,
  584. current_user: current_user,
  585. }
  586. )
  587. end
  588. else
  589. user = User.by_reset_token(params[:token])
  590. end
  591. if user
  592. render json: { message: 'ok', user_login: user.login }, status: :ok
  593. else
  594. render json: { message: 'failed' }, status: :ok
  595. end
  596. end
  597. =begin
  598. Resource:
  599. POST /api/v1/users/password_change
  600. Payload:
  601. {
  602. "password_old": "some_password_old",
  603. "password_new": "some_password_new"
  604. }
  605. Response:
  606. {
  607. :message => 'ok'
  608. }
  609. Test:
  610. curl http://localhost/api/v1/users/password_change.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"password_old": "password_old", "password_new": "password_new"}'
  611. =end
  612. def password_change
  613. # check old password
  614. if !params[:password_old]
  615. render json: { message: 'failed', notice: ['Current password needed!'] }, status: :ok
  616. return
  617. end
  618. user = User.authenticate(current_user.login, params[:password_old])
  619. if !user
  620. render json: { message: 'failed', notice: ['Current password is wrong!'] }, status: :ok
  621. return
  622. end
  623. # set new password
  624. if !params[:password_new]
  625. render json: { message: 'failed', notice: ['Please supply your new password!'] }, status: :ok
  626. return
  627. end
  628. # check password policy
  629. result = password_policy(params[:password_new])
  630. if result != true
  631. render json: { message: 'failed', notice: result }, status: :ok
  632. return
  633. end
  634. user.update_attributes(password: params[:password_new])
  635. NotificationFactory::Mailer.notification(
  636. template: 'password_change',
  637. user: user,
  638. objects: {
  639. user: user,
  640. current_user: current_user,
  641. }
  642. )
  643. render json: { message: 'ok', user_login: user.login }, status: :ok
  644. end
  645. =begin
  646. Resource:
  647. PUT /api/v1/users/preferences.json
  648. Payload:
  649. {
  650. "language": "de",
  651. "notification": true
  652. }
  653. Response:
  654. {
  655. :message => 'ok'
  656. }
  657. Test:
  658. curl http://localhost/api/v1/users/preferences.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X PUT -d '{"language": "de", "notifications": true}'
  659. =end
  660. def preferences
  661. raise Exceptions::UnprocessableEntity, 'No current user!' if !current_user
  662. if params[:user]
  663. user = User.find(current_user.id)
  664. user.with_lock do
  665. params[:user].each { |key, value|
  666. user.preferences[key.to_sym] = value
  667. }
  668. user.save
  669. end
  670. end
  671. render json: { message: 'ok' }, status: :ok
  672. end
  673. =begin
  674. Resource:
  675. DELETE /api/v1/users/account.json
  676. Payload:
  677. {
  678. "provider": "twitter",
  679. "uid": 581482342942
  680. }
  681. Response:
  682. {
  683. :message => 'ok'
  684. }
  685. Test:
  686. curl http://localhost/api/v1/users/account.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X PUT -d '{"provider": "twitter", "uid": 581482342942}'
  687. =end
  688. def account_remove
  689. raise Exceptions::UnprocessableEntity, 'No current user!' if !current_user
  690. # provider + uid to remove
  691. raise Exceptions::UnprocessableEntity, 'provider needed!' if !params[:provider]
  692. raise Exceptions::UnprocessableEntity, 'uid needed!' if !params[:uid]
  693. # remove from database
  694. record = Authorization.where(
  695. user_id: current_user.id,
  696. provider: params[:provider],
  697. uid: params[:uid],
  698. )
  699. raise Exceptions::UnprocessableEntity, 'No record found!' if !record.first
  700. record.destroy_all
  701. render json: { message: 'ok' }, status: :ok
  702. end
  703. =begin
  704. Resource:
  705. GET /api/v1/users/image/8d6cca1c6bdc226cf2ba131e264ca2c7
  706. Response:
  707. <IMAGE>
  708. Test:
  709. curl http://localhost/api/v1/users/image/8d6cca1c6bdc226cf2ba131e264ca2c7 -v -u #{login}:#{password}
  710. =end
  711. def image
  712. # cache image
  713. response.headers['Expires'] = 1.year.from_now.httpdate
  714. response.headers['Cache-Control'] = 'cache, store, max-age=31536000, must-revalidate'
  715. response.headers['Pragma'] = 'cache'
  716. file = Avatar.get_by_hash(params[:hash])
  717. if file
  718. send_data(
  719. file.content,
  720. filename: file.filename,
  721. type: file.preferences['Content-Type'] || file.preferences['Mime-Type'],
  722. disposition: 'inline'
  723. )
  724. return
  725. end
  726. # serve default image
  727. image = 'R0lGODdhMAAwAOMAAMzMzJaWlr6+vqqqqqOjo8XFxbe3t7GxsZycnAAAAAAAAAAAAAAAAAAAAAAAAAAAACwAAAAAMAAwAAAEcxDISau9OOvNu/9gKI5kaZ5oqq5s675wLM90bd94ru98TwuAA+KQAQqJK8EAgBAgMEqmkzUgBIeSwWGZtR5XhSqAULACCoGCJGwlm1MGQrq9RqgB8fm4ZTUgDBIEcRR9fz6HiImKi4yNjo+QkZKTlJWWkBEAOw=='
  728. send_data(
  729. Base64.decode64(image),
  730. filename: 'image.gif',
  731. type: 'image/gif',
  732. disposition: 'inline'
  733. )
  734. end
  735. =begin
  736. Resource:
  737. POST /api/v1/users/avatar
  738. Payload:
  739. {
  740. "avatar_full": "base64 url",
  741. }
  742. Response:
  743. {
  744. message: 'ok'
  745. }
  746. Test:
  747. curl http://localhost/api/v1/users/avatar -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"avatar": "base64 url"}'
  748. =end
  749. def avatar_new
  750. return if !valid_session_with_user
  751. # get & validate image
  752. file_full = StaticAssets.data_url_attributes(params[:avatar_full])
  753. file_resize = StaticAssets.data_url_attributes(params[:avatar_resize])
  754. avatar = Avatar.add(
  755. object: 'User',
  756. o_id: current_user.id,
  757. full: {
  758. content: file_full[:content],
  759. mime_type: file_full[:mime_type],
  760. },
  761. resize: {
  762. content: file_resize[:content],
  763. mime_type: file_resize[:mime_type],
  764. },
  765. source: 'upload ' + Time.zone.now.to_s,
  766. deletable: true,
  767. )
  768. # update user link
  769. user = User.find(current_user.id)
  770. user.update_attributes(image: avatar.store_hash)
  771. render json: { avatar: avatar }, status: :ok
  772. end
  773. def avatar_set_default
  774. return if !valid_session_with_user
  775. # get & validate image
  776. raise Exceptions::UnprocessableEntity, 'No id of avatar!' if !params[:id]
  777. # set as default
  778. avatar = Avatar.set_default('User', current_user.id, params[:id])
  779. # update user link
  780. user = User.find(current_user.id)
  781. user.update_attributes(image: avatar.store_hash)
  782. render json: {}, status: :ok
  783. end
  784. def avatar_destroy
  785. return if !valid_session_with_user
  786. # get & validate image
  787. raise Exceptions::UnprocessableEntity, 'No id of avatar!' if !params[:id]
  788. # remove avatar
  789. Avatar.remove_one('User', current_user.id, params[:id])
  790. # update user link
  791. avatar = Avatar.get_default('User', current_user.id)
  792. user = User.find(current_user.id)
  793. user.update_attributes(image: avatar.store_hash)
  794. render json: {}, status: :ok
  795. end
  796. def avatar_list
  797. return if !valid_session_with_user
  798. # list of avatars
  799. result = Avatar.list('User', current_user.id)
  800. render json: { avatars: result }, status: :ok
  801. end
  802. private
  803. def password_policy(password)
  804. if Setting.get('password_min_size').to_i > password.length
  805. return ["Can\'t update password, it must be at least %s characters long!", Setting.get('password_min_size')]
  806. end
  807. if Setting.get('password_need_digit').to_i == 1 && password !~ /\d/
  808. return ["Can't update password, it must contain at least 1 digit!"]
  809. end
  810. if Setting.get('password_min_2_lower_2_upper_characters').to_i == 1 && ( password !~ /[A-Z].*[A-Z]/ || password !~ /[a-z].*[a-z]/ )
  811. return ["Can't update password, it must contain at least 2 lowercase and 2 uppercase characters!"]
  812. end
  813. true
  814. end
  815. def permission_check_by_permission(params)
  816. return true if current_user.permissions?('admin.user')
  817. %i(role_ids roles).each do |key|
  818. next if !params[key]
  819. if current_user.permissions?('ticket.agent')
  820. params.delete(key)
  821. else
  822. logger.info "Role assignment is only allowed by admin! current_user_id: #{current_user.id} assigned to #{params[key].inspect}"
  823. raise Exceptions::NotAuthorized, 'This role assignment is only allowed by admin!'
  824. end
  825. end
  826. if current_user.permissions?('ticket.agent') && !params[:role_ids] && !params[:roles] && params[:id].blank?
  827. params[:role_ids] = Role.signup_role_ids
  828. end
  829. %i(group_ids groups).each do |key|
  830. next if !params[key]
  831. if current_user.permissions?('ticket.agent')
  832. params.delete(key)
  833. else
  834. logger.info "Group relation assignment is only allowed by admin! current_user_id: #{current_user.id} assigned to #{params[key].inspect}"
  835. raise Exceptions::NotAuthorized, 'Group relation is only allowed by admin!'
  836. end
  837. end
  838. return true if current_user.permissions?('ticket.agent')
  839. response_access_deny
  840. false
  841. end
  842. end