1 # -*- coding: utf-8 -*-
4 import werkzeug.wrappers
7 from urllib2 import urlopen
9 from openerp import tools
10 from openerp.addons.web import http
11 from openerp.addons.web.controllers.main import login_redirect
12 from openerp.addons.web.http import request
13 from openerp.addons.website.controllers.main import Website as controllers
14 from openerp.addons.website.models.website import slug
16 controllers = controllers()
19 class WebsiteForum(http.Controller):
23 def _get_notifications(self):
24 badge_subtype = request.env.ref('gamification.mt_badge_granted')
26 msg = request.env['mail.message'].search([('subtype_id', '=', badge_subtype.id), ('to_read', '=', True)])
31 def _prepare_forum_values(self, forum=None, **kwargs):
33 'user': request.env.user,
34 'is_public_user': request.env.user.id == request.website.user_id.id,
35 'notifications': self._get_notifications(),
36 'header': kwargs.get('header', dict()),
37 'searches': kwargs.get('searches', dict()),
38 'no_introduction_message': request.httprequest.cookies.get('no_introduction_message', False),
39 'validation_email_sent': request.session.get('validation_email_sent', False),
40 'validation_email_done': request.session.get('validation_email_done', False),
43 values['forum'] = forum
44 elif kwargs.get('forum_id'):
45 values['forum'] = request.env['forum.forum'].browse(kwargs.pop('forum_id'))
50 # --------------------------------------------------
52 @http.route('/forum/send_validation_email', type='json', auth='user', website=True)
53 def send_validation_email(self, forum_id=None, **kwargs):
54 if request.env.uid != request.website.user_id.id:
55 request.env.user.send_forum_validation_email(forum_id=forum_id)
56 request.session['validation_email_sent'] = True
59 @http.route('/forum/validate_email', type='http', auth='public', website=True)
60 def validate_email(self, token, id, email, forum_id=None, **kwargs):
63 forum_id = int(forum_id)
66 done = request.env['res.users'].sudo().browse(int(id)).process_forum_validation_token(token, email, forum_id=forum_id)[0]
68 request.session['validation_email_done'] = True
70 return request.redirect("/forum/%s" % int(forum_id))
71 return request.redirect('/forum')
73 @http.route('/forum/validate_email/close', type='json', auth='public', website=True)
74 def validate_email_done(self):
75 request.session['validation_email_done'] = False
79 # --------------------------------------------------
81 @http.route(['/forum'], type='http', auth="public", website=True)
82 def forum(self, **kwargs):
83 forums = request.env['forum.forum'].search([])
84 return request.website.render("website_forum.forum_all", {'forums': forums})
86 @http.route('/forum/new', type='http', auth="user", methods=['POST'], website=True)
87 def forum_create(self, forum_name="New Forum", **kwargs):
88 forum_id = request.env['forum.forum'].create({'name': forum_name})
89 return request.redirect("/forum/%s" % slug(forum_id))
91 @http.route('/forum/notification_read', type='json', auth="user", methods=['POST'], website=True)
92 def notification_read(self, **kwargs):
93 request.env['mail.message'].browse([int(kwargs.get('notification_id'))]).set_message_read(read=True)
96 @http.route(['/forum/<model("forum.forum"):forum>',
97 '/forum/<model("forum.forum"):forum>/page/<int:page>',
98 '''/forum/<model("forum.forum"):forum>/tag/<model("forum.tag", "[('forum_id','=',forum[0])]"):tag>/questions''',
99 '''/forum/<model("forum.forum"):forum>/tag/<model("forum.tag", "[('forum_id','=',forum[0])]"):tag>/questions/page/<int:page>''',
100 ], type='http', auth="public", website=True)
101 def questions(self, forum, tag=None, page=1, filters='all', sorting=None, search='', post_type=None, **post):
102 Post = request.env['forum.post']
104 domain = [('forum_id', '=', forum.id), ('parent_id', '=', False), ('state', '=', 'active')]
106 domain += ['|', ('name', 'ilike', search), ('content', 'ilike', search)]
108 domain += [('tag_ids', 'in', tag.id)]
109 if filters == 'unanswered':
110 domain += [('child_ids', '=', False)]
111 elif filters == 'followed':
112 domain += [('message_follower_ids', '=', request.env.user.partner_id.id)]
114 domain += [('post_type', '=', post_type)]
117 sorting = forum.default_order
119 question_count = Post.search_count(domain)
122 url = "/forum/%s/tag/%s/questions" % (slug(forum), slug(tag))
124 url = "/forum/%s" % slug(forum)
130 url_args['search'] = search
132 url_args['filters'] = filters
133 pager = request.website.pager(url=url, total=question_count, page=page,
134 step=self._post_per_page, scope=self._post_per_page,
137 question_ids = Post.search(domain, limit=self._post_per_page, offset=pager['offset'], order=sorting)
139 values = self._prepare_forum_values(forum=forum, searches=post)
141 'main_object': tag or forum,
142 'question_ids': question_ids,
143 'question_count': question_count,
149 'post_type': post_type,
151 return request.website.render("website_forum.forum_index", values)
153 @http.route(['/forum/<model("forum.forum"):forum>/faq'], type='http', auth="public", website=True)
154 def forum_faq(self, forum, **post):
155 values = self._prepare_forum_values(forum=forum, searches=dict(), header={'is_guidelines': True}, **post)
156 return request.website.render("website_forum.faq", values)
158 @http.route('/forum/get_tags', type='http', auth="public", methods=['GET'], website=True)
159 def tag_read(self, **post):
160 tags = request.env['forum.tag'].search_read([], ['name'])
161 data = [tag['name'] for tag in tags]
162 return simplejson.dumps(data)
164 @http.route(['/forum/<model("forum.forum"):forum>/tag'], type='http', auth="public", website=True)
165 def tags(self, forum, page=1, **post):
166 tags = request.env['forum.tag'].search([('forum_id', '=', forum.id), ('posts_count', '>', 0)], limit=None, order='posts_count DESC')
167 values = self._prepare_forum_values(forum=forum, searches={'tags': True}, **post)
170 'main_object': forum,
172 return request.website.render("website_forum.tag", values)
175 # --------------------------------------------------
177 @http.route('/forum/get_url_title', type='json', auth="user", methods=['POST'], website=True)
178 def get_url_title(self, **kwargs):
179 arch = lxml.html.parse(urlopen(kwargs.get('url')))
180 return arch.find(".//title").text
182 @http.route(['''/forum/<model("forum.forum"):forum>/question/<model("forum.post", "[('forum_id','=',forum[0]),('parent_id','=',False)]"):question>'''], type='http', auth="public", website=True)
183 def question(self, forum, question, **post):
184 # increment view counter
185 question.sudo().set_viewed()
186 if question.parent_id:
187 redirect_url = "/forum/%s/question/%s" % (slug(forum), slug(question.parent_id))
188 return werkzeug.utils.redirect(redirect_url, 301)
190 values = self._prepare_forum_values(forum=forum, searches=post)
192 'main_object': question,
193 'question': question,
194 'header': {'question_data': True},
196 'reversed': reversed,
198 return request.website.render("website_forum.post_description_full", values)
200 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/toggle_favourite', type='json', auth="user", methods=['POST'], website=True)
201 def question_toggle_favorite(self, forum, question, **post):
202 if not request.session.uid:
203 return {'error': 'anonymous_user'}
204 # TDE: add check for not public
205 favourite = False if question.user_favourite else True
207 favourite_ids = [(4, request.uid)]
209 favourite_ids = [(3, request.uid)]
210 question.sudo().write({'favourite_ids': favourite_ids})
213 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/ask_for_close', type='http', auth="user", methods=['POST'], website=True)
214 def question_ask_for_close(self, forum, question, **post):
215 reasons = request.env['forum.post.reason'].search([])
217 values = self._prepare_forum_values(**post)
219 'question': question,
220 'question': question,
224 return request.website.render("website_forum.close_post", values)
226 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/edit_answer', type='http', auth="user", website=True)
227 def question_edit_answer(self, forum, question, **kwargs):
228 for record in question.child_ids:
229 if record.create_uid.id == request.uid:
232 return werkzeug.utils.redirect("/forum/%s/post/%s/edit" % (slug(forum), slug(answer)))
234 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/close', type='http', auth="user", methods=['POST'], website=True)
235 def question_close(self, forum, question, **post):
236 question.close(reason_id=int(post.get('reason_id', False)))
237 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
239 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/reopen', type='http', auth="user", methods=['POST'], website=True)
240 def question_reopen(self, forum, question, **kwarg):
242 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
244 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/delete', type='http', auth="user", methods=['POST'], website=True)
245 def question_delete(self, forum, question, **kwarg):
246 question.active = False
247 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
249 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/undelete', type='http', auth="user", methods=['POST'], website=True)
250 def question_undelete(self, forum, question, **kwarg):
251 question.active = True
252 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
255 # --------------------------------------------------
257 @http.route(['/forum/<model("forum.forum"):forum>/ask'], type='http', auth="public", website=True)
258 def forum_post(self, forum, post_type=None, **post):
259 if not request.session.uid:
260 return login_redirect()
261 user = request.env.user
262 if not post_type in ['question', 'link', 'discussion']: # fixme: make dynamic
263 return werkzeug.utils.redirect('/forum/%s' % slug(forum))
264 if not user.email or not tools.single_email_re.match(user.email):
265 return werkzeug.utils.redirect("/forum/%s/user/%s/edit?email_required=1" % (slug(forum), request.session.uid))
266 values = self._prepare_forum_values(forum=forum, searches={}, header={'ask_hide': True})
267 return request.website.render("website_forum.new_%s" % post_type, values)
269 @http.route(['/forum/<model("forum.forum"):forum>/new',
270 '/forum/<model("forum.forum"):forum>/<model("forum.post"):post_parent>/reply'],
271 type='http', auth="public", methods=['POST'], website=True)
272 def post_create(self, forum, post_parent=None, post_type=None, **post):
273 cr, uid, context = request.cr, request.uid, request.context
274 if not request.session.uid:
275 return login_redirect()
278 Tag = request.env['forum.tag']
279 if post.get('post_tags', False) and post.get('post_tags').strip('[]'):
280 tags = post.get('post_tags').strip('[]').replace('"', '').split(",")
282 tag_rec = Tag.search([('name', '=', tag)])
284 post_tag_ids.append((4, tag_rec.id))
286 post_tag_ids.append((0, 0, {'name': tag, 'forum_id': forum.id}))
288 new_question = request.env['forum.post'].create({
289 'forum_id': forum.id,
290 'name': post.get('post_name', ''),
291 'content': post.get('content', False),
292 'content_link': post.get('content_link', False),
293 'parent_id': post_parent and post_parent.id or False,
294 'tag_ids': post_tag_ids,
295 'post_type': post_parent and post_parent.post_type or post_type, # tde check in selection field
297 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), post_parent and slug(post_parent) or new_question.id))
299 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/comment', type='http', auth="public", methods=['POST'], website=True)
300 def post_comment(self, forum, post, **kwargs):
301 if not request.session.uid:
302 return login_redirect()
303 question = post.parent_id if post.parent_id else post
304 if kwargs.get('comment') and post.forum_id.id == forum.id:
305 # TDE FIXME: check that post_id is the question or one of its answers
306 post.with_context(mail_create_nosubcribe=True).message_post(
307 body=kwargs.get('comment'),
309 subtype='mt_comment')
310 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
312 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/toggle_correct', type='json', auth="public", website=True)
313 def post_toggle_correct(self, forum, post, **kwargs):
314 if post.parent_id is False:
315 return request.redirect('/')
316 if not request.session.uid:
317 return {'error': 'anonymous_user'}
319 # set all answers to False, only one can be accepted
320 (post.parent_id.child_ids - post).write(dict(is_correct=False))
321 post.is_correct = not post.is_correct
322 return post.is_correct
324 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/delete', type='http', auth="user", methods=['POST'], website=True)
325 def post_delete(self, forum, post, **kwargs):
326 question = post.parent_id
329 werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
330 return werkzeug.utils.redirect("/forum/%s" % slug(forum))
332 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/edit', type='http', auth="user", website=True)
333 def post_edit(self, forum, post, **kwargs):
335 for tag_name in post.tag_ids:
336 tags += tag_name.name + ","
337 values = self._prepare_forum_values(forum=forum)
341 'is_answer': bool(post.parent_id),
344 return request.website.render("website_forum.edit_post", values)
346 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/save', type='http', auth="user", methods=['POST'], website=True)
347 def post_save(self, forum, post, **kwargs):
349 if kwargs.get('post_tag') and kwargs.get('post_tag').strip('[]'):
350 Tag = request.env['forum.tag']
351 tags = kwargs.get('post_tag').strip('[]').replace('"', '').split(",")
353 tag_rec = Tag.search([('name', '=', tag)])
355 post_tags += tag_rec.ids
357 new_tag = Tag.create({'name': tag, 'forum_id': forum.id})
358 post_tags.append(new_tag.id)
360 'tag_ids': [(6, 0, post_tags)],
361 'name': kwargs.get('post_name'),
362 'content': kwargs.get('content'),
365 question = post.parent_id if post.parent_id else post
366 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
368 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/upvote', type='json', auth="public", website=True)
369 def post_upvote(self, forum, post, **kwargs):
370 if not request.session.uid:
371 return {'error': 'anonymous_user'}
372 if request.uid == post.create_uid.id:
373 return {'error': 'own_post'}
374 upvote = True if not post.user_vote > 0 else False
375 return post.vote(upvote=upvote)
377 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/downvote', type='json', auth="public", website=True)
378 def post_downvote(self, forum, post, **kwargs):
379 if not request.session.uid:
380 return {'error': 'anonymous_user'}
381 if request.uid == post.create_uid.id:
382 return {'error': 'own_post'}
383 upvote = True if post.user_vote < 0 else False
384 return post.vote(upvote=upvote)
387 # --------------------------------------------------
389 @http.route(['/forum/<model("forum.forum"):forum>/users',
390 '/forum/<model("forum.forum"):forum>/users/page/<int:page>'],
391 type='http', auth="public", website=True)
392 def users(self, forum, page=1, **searches):
393 User = request.env['res.users']
395 tag_count = len(User.search([('karma', '>', 1), ('website_published', '=', True)]))
396 pager = request.website.pager(url="/forum/%s/users" % slug(forum), total=tag_count, page=page, step=step, scope=30)
397 user_obj = User.sudo().search([('karma', '>', 1), ('website_published', '=', True)], limit=step, offset=pager['offset'], order='karma DESC')
398 # put the users in block of 3 to display them as a table
399 users = [[] for i in range(len(user_obj) / 3 + 1)]
400 for index, user in enumerate(user_obj):
401 users[index / 3].append(user)
402 searches['users'] = 'True'
404 values = self._prepare_forum_values(forum=forum, searches=searches)
407 'main_object': forum,
408 'notifications': self._get_notifications(),
412 return request.website.render("website_forum.users", values)
414 @http.route(['/forum/<model("forum.forum"):forum>/partner/<int:partner_id>'], type='http', auth="public", website=True)
415 def open_partner(self, forum, partner_id=0, **post):
417 partner = request.env['res.partner'].sudo().search([('id', '=', partner_id)])
418 if partner and partner.user_ids:
419 return werkzeug.utils.redirect("/forum/%s/user/%d" % (slug(forum), partner.user_ids[0].id))
420 return werkzeug.utils.redirect("/forum/%s" % slug(forum))
422 @http.route(['/forum/user/<int:user_id>/avatar'], type='http', auth="public", website=True)
423 def user_avatar(self, user_id=0, **post):
424 response = werkzeug.wrappers.Response()
425 User = request.env['res.users']
426 Website = request.env['website']
427 user = User.sudo().search([('id', '=', user_id)])
428 if not user.exists() or (user_id != request.session.uid and user.karma < 1):
429 return Website._image_placeholder(response)
430 return Website._image('res.users', user.id, 'image', response)
432 @http.route(['/forum/<model("forum.forum"):forum>/user/<int:user_id>'], type='http', auth="public", website=True)
433 def open_user(self, forum, user_id=0, **post):
434 User = request.env['res.users']
435 Post = request.env['forum.post']
436 Vote = request.env['forum.post.vote']
437 Activity = request.env['mail.message']
438 Followers = request.env['mail.followers']
439 Data = request.env["ir.model.data"]
441 user = User.sudo().search([('id', '=', user_id)])
442 if not user or user.karma < 1:
443 return werkzeug.utils.redirect("/forum/%s" % slug(forum))
444 values = self._prepare_forum_values(forum=forum, **post)
445 if user_id != request.session.uid and not user.website_published:
446 return request.website.render("website_forum.private_profile", values)
447 # questions and answers by user
448 user_questions, user_answers = [], []
449 user_question_ids = Post.search([
450 ('parent_id', '=', False),
451 ('forum_id', '=', forum.id), ('create_uid', '=', user.id)],
452 order='create_date desc')
453 count_user_questions = len(user_question_ids)
454 # displaying only the 20 most recent questions
455 user_questions = user_question_ids[:20]
457 user_answer_ids = Post.search([
458 ('parent_id', '!=', False),
459 ('forum_id', '=', forum.id), ('create_uid', '=', user.id)],
460 order='create_date desc')
461 count_user_answers = len(user_answer_ids)
462 # displaying only the 20 most recent answers
463 user_answers = user_answer_ids[:20]
465 # showing questions which user following
466 post_ids = [follower.res_id for follower in Followers.sudo().search([('res_model', '=', 'forum.post'), ('partner_id', '=', user.partner_id.id)])]
467 followed = Post.search([('id', 'in', post_ids), ('forum_id', '=', forum.id), ('parent_id', '=', False)])
469 # showing Favourite questions of user.
470 favourite = Post.search([('favourite_ids', '=', user.id), ('forum_id', '=', forum.id), ('parent_id', '=', False)])
472 # votes which given on users questions and answers.
473 data = Vote.read_group([('forum_id', '=', forum.id), ('recipient_id', '=', user.id)], ["vote"], groupby=["vote"])
474 up_votes, down_votes = 0, 0
476 if rec['vote'] == '1':
477 up_votes = rec['vote_count']
478 elif rec['vote'] == '-1':
479 down_votes = rec['vote_count']
481 # Votes which given by users on others questions and answers.
482 vote_ids = Vote.search([('user_id', '=', user.id)])
485 model, comment = Data.get_object_reference('mail', 'mt_comment')
486 activities = Activity.search([('res_id', 'in', (user_question_ids+user_answer_ids).ids), ('model', '=', 'forum.post'), ('subtype_id', '!=', comment)], order='date DESC', limit=100)
489 for act in activities:
490 posts[act.res_id] = True
491 posts_ids = Post.search([('id', 'in', posts.keys())])
492 posts = dict(map(lambda x: (x.id, (x.parent_id or x, x.parent_id and x or False)), posts_ids))
494 # TDE CLEANME MASTER: couldn't it be rewritten using a 'menu' key instead of one key for each menu ?
495 if user == request.env.user:
496 post['my_profile'] = True
501 'uid': request.env.user.id,
505 'questions': user_questions,
506 'count_questions': count_user_questions,
507 'answers': user_answers,
508 'count_answers': count_user_answers,
509 'followed': followed,
510 'favourite': favourite,
511 'up_votes': up_votes,
512 'down_votes': down_votes,
513 'activities': activities,
515 'vote_post': vote_ids,
517 return request.website.render("website_forum.user_detail_full", values)
519 @http.route('/forum/<model("forum.forum"):forum>/user/<model("res.users"):user>/edit', type='http', auth="user", website=True)
520 def edit_profile(self, forum, user, **kwargs):
521 countries = request.env['res.country'].search([])
522 values = self._prepare_forum_values(forum=forum, searches=kwargs)
524 'email_required': kwargs.get('email_required'),
525 'countries': countries,
526 'notifications': self._get_notifications(),
528 return request.website.render("website_forum.edit_profile", values)
530 @http.route('/forum/<model("forum.forum"):forum>/user/<model("res.users"):user>/save', type='http', auth="user", methods=['POST'], website=True)
531 def save_edited_profile(self, forum, user, **kwargs):
533 'name': kwargs.get('name'),
534 'website': kwargs.get('website'),
535 'email': kwargs.get('email'),
536 'city': kwargs.get('city'),
537 'country_id': int(kwargs.get('country')) if kwargs.get('country') else False,
538 'website_description': kwargs.get('description'),
540 if request.uid == user.id: # the controller allows to edit only its own privacy settings; use partner management for other cases
541 values['website_published'] = kwargs.get('website_published') == 'True'
543 return werkzeug.utils.redirect("/forum/%s/user/%d" % (slug(forum), user.id))
546 # --------------------------------------------------
548 @http.route('/forum/<model("forum.forum"):forum>/badge', type='http', auth="public", website=True)
549 def badges(self, forum, **searches):
550 Badge = request.env['gamification.badge']
551 badges = Badge.sudo().search([('challenge_ids.category', '=', 'forum')])
552 badges = sorted(badges, key=lambda b: b.stat_count_distinct, reverse=True)
553 values = self._prepare_forum_values(forum=forum, searches={'badges': True})
557 return request.website.render("website_forum.badge", values)
559 @http.route(['''/forum/<model("forum.forum"):forum>/badge/<model("gamification.badge"):badge>'''], type='http', auth="public", website=True)
560 def badge_users(self, forum, badge, **kwargs):
561 users = [badge_user.user_id for badge_user in badge.sudo().owner_ids]
562 values = self._prepare_forum_values(forum=forum, searches={'badges': True})
567 return request.website.render("website_forum.badge_user", values)
570 # --------------------------------------------------
572 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/comment/<model("mail.message"):comment>/convert_to_answer', type='http', auth="user", methods=['POST'], website=True)
573 def convert_comment_to_answer(self, forum, post, comment, **kwarg):
574 post = request.env['forum.post'].convert_comment_to_answer(comment.id)
576 return werkzeug.utils.redirect("/forum/%s" % slug(forum))
577 question = post.parent_id if post.parent_id else post
578 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
580 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/convert_to_comment', type='http', auth="user", methods=['POST'], website=True)
581 def convert_answer_to_comment(self, forum, post, **kwarg):
582 question = post.parent_id
583 new_msg_id = post.convert_answer_to_comment()[0]
585 return werkzeug.utils.redirect("/forum/%s" % slug(forum))
586 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
588 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/comment/<model("mail.message"):comment>/delete', type='json', auth="user", website=True)
589 def delete_comment(self, forum, post, comment, **kwarg):
590 if not request.session.uid:
591 return {'error': 'anonymous_user'}
592 return post.unlink_comment(comment.id)[0]