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, q='', l=25, **post):
160 data = request.env['forum.tag'].search_read(
161 domain=[('name', '=ilike', (q or '') + "%")],
162 fields=['id', 'name'],
165 return simplejson.dumps(data)
167 @http.route(['/forum/<model("forum.forum"):forum>/tag'], type='http', auth="public", website=True)
168 def tags(self, forum, page=1, **post):
169 tags = request.env['forum.tag'].search([('forum_id', '=', forum.id), ('posts_count', '>', 0)], limit=None, order='posts_count DESC')
170 values = self._prepare_forum_values(forum=forum, searches={'tags': True}, **post)
173 'main_object': forum,
175 return request.website.render("website_forum.tag", values)
178 # --------------------------------------------------
180 @http.route('/forum/get_url_title', type='json', auth="user", methods=['POST'], website=True)
181 def get_url_title(self, **kwargs):
182 arch = lxml.html.parse(urlopen(kwargs.get('url')))
183 return arch.find(".//title").text
185 @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)
186 def question(self, forum, question, **post):
187 # increment view counter
188 question.sudo().set_viewed()
189 if question.parent_id:
190 redirect_url = "/forum/%s/question/%s" % (slug(forum), slug(question.parent_id))
191 return werkzeug.utils.redirect(redirect_url, 301)
193 values = self._prepare_forum_values(forum=forum, searches=post)
195 'main_object': question,
196 'question': question,
197 'header': {'question_data': True},
199 'reversed': reversed,
201 return request.website.render("website_forum.post_description_full", values)
203 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/toggle_favourite', type='json', auth="user", methods=['POST'], website=True)
204 def question_toggle_favorite(self, forum, question, **post):
205 if not request.session.uid:
206 return {'error': 'anonymous_user'}
207 # TDE: add check for not public
208 favourite = False if question.user_favourite else True
210 favourite_ids = [(4, request.uid)]
212 favourite_ids = [(3, request.uid)]
213 question.sudo().write({'favourite_ids': favourite_ids})
216 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/ask_for_close', type='http', auth="user", methods=['POST'], website=True)
217 def question_ask_for_close(self, forum, question, **post):
218 reasons = request.env['forum.post.reason'].search([])
220 values = self._prepare_forum_values(**post)
222 'question': question,
223 'question': question,
227 return request.website.render("website_forum.close_post", values)
229 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/edit_answer', type='http', auth="user", website=True)
230 def question_edit_answer(self, forum, question, **kwargs):
231 for record in question.child_ids:
232 if record.create_uid.id == request.uid:
235 return werkzeug.utils.redirect("/forum/%s/post/%s/edit" % (slug(forum), slug(answer)))
237 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/close', type='http', auth="user", methods=['POST'], website=True)
238 def question_close(self, forum, question, **post):
239 question.close(reason_id=int(post.get('reason_id', False)))
240 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
242 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/reopen', type='http', auth="user", methods=['POST'], website=True)
243 def question_reopen(self, forum, question, **kwarg):
245 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
247 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/delete', type='http', auth="user", methods=['POST'], website=True)
248 def question_delete(self, forum, question, **kwarg):
249 question.active = False
250 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
252 @http.route('/forum/<model("forum.forum"):forum>/question/<model("forum.post"):question>/undelete', type='http', auth="user", methods=['POST'], website=True)
253 def question_undelete(self, forum, question, **kwarg):
254 question.active = True
255 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
258 # --------------------------------------------------
259 @http.route(['/forum/<model("forum.forum"):forum>/ask'], type='http', auth="public", website=True)
260 def forum_post(self, forum, post_type=None, **post):
261 if not request.session.uid:
262 return login_redirect()
263 user = request.env.user
264 if post_type not in ['question', 'link', 'discussion']: # fixme: make dynamic
265 return werkzeug.utils.redirect('/forum/%s' % slug(forum))
266 if not user.email or not tools.single_email_re.match(user.email):
267 return werkzeug.utils.redirect("/forum/%s/user/%s/edit?email_required=1" % (slug(forum), request.session.uid))
268 values = self._prepare_forum_values(forum=forum, searches={}, header={'ask_hide': True})
269 return request.website.render("website_forum.new_%s" % post_type, values)
271 @http.route(['/forum/<model("forum.forum"):forum>/new',
272 '/forum/<model("forum.forum"):forum>/<model("forum.post"):post_parent>/reply'],
273 type='http', auth="public", methods=['POST'], website=True)
274 def post_create(self, forum, post_parent=None, post_type=None, **post):
275 if not request.session.uid:
276 return login_redirect()
277 post_tag_ids = forum._tag_to_write_vals(post.get('post_tags', ''))
278 new_question = request.env['forum.post'].create({
279 'forum_id': forum.id,
280 'name': post.get('post_name', ''),
281 'content': post.get('content', False),
282 'content_link': post.get('content_link', False),
283 'parent_id': post_parent and post_parent.id or False,
284 'tag_ids': post_tag_ids,
285 'post_type': post_parent and post_parent.post_type or post_type, # tde check in selection field
287 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), post_parent and slug(post_parent) or new_question.id))
289 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/comment', type='http', auth="public", methods=['POST'], website=True)
290 def post_comment(self, forum, post, **kwargs):
291 if not request.session.uid:
292 return login_redirect()
293 question = post.parent_id if post.parent_id else post
294 if kwargs.get('comment') and post.forum_id.id == forum.id:
295 # TDE FIXME: check that post_id is the question or one of its answers
296 post.with_context(mail_create_nosubcribe=True).message_post(
297 body=kwargs.get('comment'),
299 subtype='mt_comment')
300 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
302 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/toggle_correct', type='json', auth="public", website=True)
303 def post_toggle_correct(self, forum, post, **kwargs):
304 if post.parent_id is False:
305 return request.redirect('/')
306 if not request.session.uid:
307 return {'error': 'anonymous_user'}
309 # set all answers to False, only one can be accepted
310 (post.parent_id.child_ids - post).write(dict(is_correct=False))
311 post.is_correct = not post.is_correct
312 return post.is_correct
314 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/delete', type='http', auth="user", methods=['POST'], website=True)
315 def post_delete(self, forum, post, **kwargs):
316 question = post.parent_id
319 werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
320 return werkzeug.utils.redirect("/forum/%s" % slug(forum))
322 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/edit', type='http', auth="user", website=True)
323 def post_edit(self, forum, post, **kwargs):
324 tags = [dict(id=tag.id, name=tag.name) for tag in post.tag_ids]
325 tags = simplejson.dumps(tags)
326 values = self._prepare_forum_values(forum=forum)
330 'is_answer': bool(post.parent_id),
333 return request.website.render("website_forum.edit_post", values)
335 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/save', type='http', auth="user", methods=['POST'], website=True)
336 def post_save(self, forum, post, **kwargs):
337 post_tags = forum._tag_to_write_vals(kwargs.get('post_tag', ''))
339 'tag_ids': post_tags,
340 'name': kwargs.get('post_name'),
341 'content': kwargs.get('content'),
344 question = post.parent_id if post.parent_id else post
345 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
347 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/upvote', type='json', auth="public", website=True)
348 def post_upvote(self, forum, post, **kwargs):
349 if not request.session.uid:
350 return {'error': 'anonymous_user'}
351 if request.uid == post.create_uid.id:
352 return {'error': 'own_post'}
353 upvote = True if not post.user_vote > 0 else False
354 return post.vote(upvote=upvote)
356 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/downvote', type='json', auth="public", website=True)
357 def post_downvote(self, forum, post, **kwargs):
358 if not request.session.uid:
359 return {'error': 'anonymous_user'}
360 if request.uid == post.create_uid.id:
361 return {'error': 'own_post'}
362 upvote = True if post.user_vote < 0 else False
363 return post.vote(upvote=upvote)
366 # --------------------------------------------------
368 @http.route(['/forum/<model("forum.forum"):forum>/users',
369 '/forum/<model("forum.forum"):forum>/users/page/<int:page>'],
370 type='http', auth="public", website=True)
371 def users(self, forum, page=1, **searches):
372 User = request.env['res.users']
374 tag_count = len(User.search([('karma', '>', 1), ('website_published', '=', True)]))
375 pager = request.website.pager(url="/forum/%s/users" % slug(forum), total=tag_count, page=page, step=step, scope=30)
376 user_obj = User.sudo().search([('karma', '>', 1), ('website_published', '=', True)], limit=step, offset=pager['offset'], order='karma DESC')
377 # put the users in block of 3 to display them as a table
378 users = [[] for i in range(len(user_obj) / 3 + 1)]
379 for index, user in enumerate(user_obj):
380 users[index / 3].append(user)
381 searches['users'] = 'True'
383 values = self._prepare_forum_values(forum=forum, searches=searches)
386 'main_object': forum,
387 'notifications': self._get_notifications(),
391 return request.website.render("website_forum.users", values)
393 @http.route(['/forum/<model("forum.forum"):forum>/partner/<int:partner_id>'], type='http', auth="public", website=True)
394 def open_partner(self, forum, partner_id=0, **post):
396 partner = request.env['res.partner'].sudo().search([('id', '=', partner_id)])
397 if partner and partner.user_ids:
398 return werkzeug.utils.redirect("/forum/%s/user/%d" % (slug(forum), partner.user_ids[0].id))
399 return werkzeug.utils.redirect("/forum/%s" % slug(forum))
401 @http.route(['/forum/user/<int:user_id>/avatar'], type='http', auth="public", website=True)
402 def user_avatar(self, user_id=0, **post):
403 response = werkzeug.wrappers.Response()
404 User = request.env['res.users']
405 Website = request.env['website']
406 user = User.sudo().search([('id', '=', user_id)])
407 if not user.exists() or (user_id != request.session.uid and user.karma < 1):
408 return Website._image_placeholder(response)
409 return Website._image('res.users', user.id, 'image', response)
411 @http.route(['/forum/<model("forum.forum"):forum>/user/<int:user_id>'], type='http', auth="public", website=True)
412 def open_user(self, forum, user_id=0, **post):
413 User = request.env['res.users']
414 Post = request.env['forum.post']
415 Vote = request.env['forum.post.vote']
416 Activity = request.env['mail.message']
417 Followers = request.env['mail.followers']
418 Data = request.env["ir.model.data"]
420 user = User.sudo().search([('id', '=', user_id)])
421 current_user = request.env.user.sudo()
423 # Users with high karma can see users with karma <= 0 for
424 # moderation purposes, IFF they have posted something (see below)
425 if (not user or (user.karma < 1 and current_user.karma < forum.karma_unlink_all)):
426 return werkzeug.utils.redirect("/forum/%s" % slug(forum))
427 values = self._prepare_forum_values(forum=forum, **post)
429 # questions and answers by user
430 user_question_ids = Post.search([
431 ('parent_id', '=', False),
432 ('forum_id', '=', forum.id), ('create_uid', '=', user.id)],
433 order='create_date desc')
434 count_user_questions = len(user_question_ids)
436 if (user_id != request.session.uid and not
437 (user.website_published or
438 (count_user_questions and current_user.karma > forum.karma_unlink_all))):
439 return request.website.render("website_forum.private_profile", values)
441 # displaying only the 20 most recent questions
442 user_questions = user_question_ids[:20]
444 user_answer_ids = Post.search([
445 ('parent_id', '!=', False),
446 ('forum_id', '=', forum.id), ('create_uid', '=', user.id)],
447 order='create_date desc')
448 count_user_answers = len(user_answer_ids)
449 # displaying only the 20 most recent answers
450 user_answers = user_answer_ids[:20]
452 # showing questions which user following
453 post_ids = [follower.res_id for follower in Followers.sudo().search([('res_model', '=', 'forum.post'), ('partner_id', '=', user.partner_id.id)])]
454 followed = Post.search([('id', 'in', post_ids), ('forum_id', '=', forum.id), ('parent_id', '=', False)])
456 # showing Favourite questions of user.
457 favourite = Post.search([('favourite_ids', '=', user.id), ('forum_id', '=', forum.id), ('parent_id', '=', False)])
459 # votes which given on users questions and answers.
460 data = Vote.read_group([('forum_id', '=', forum.id), ('recipient_id', '=', user.id)], ["vote"], groupby=["vote"])
461 up_votes, down_votes = 0, 0
463 if rec['vote'] == '1':
464 up_votes = rec['vote_count']
465 elif rec['vote'] == '-1':
466 down_votes = rec['vote_count']
468 # Votes which given by users on others questions and answers.
469 vote_ids = Vote.search([('user_id', '=', user.id)])
472 model, comment = Data.get_object_reference('mail', 'mt_comment')
473 activities = Activity.search([('res_id', 'in', (user_question_ids + user_answer_ids).ids), ('model', '=', 'forum.post'), ('subtype_id', '!=', comment)],
474 order='date DESC', limit=100)
477 for act in activities:
478 posts[act.res_id] = True
479 posts_ids = Post.search([('id', 'in', posts.keys())])
480 posts = dict(map(lambda x: (x.id, (x.parent_id or x, x.parent_id and x or False)), posts_ids))
482 # TDE CLEANME MASTER: couldn't it be rewritten using a 'menu' key instead of one key for each menu ?
483 if user == request.env.user:
484 post['my_profile'] = True
489 'uid': request.env.user.id,
493 'questions': user_questions,
494 'count_questions': count_user_questions,
495 'answers': user_answers,
496 'count_answers': count_user_answers,
497 'followed': followed,
498 'favourite': favourite,
499 'up_votes': up_votes,
500 'down_votes': down_votes,
501 'activities': activities,
503 'vote_post': vote_ids,
505 return request.website.render("website_forum.user_detail_full", values)
507 @http.route('/forum/<model("forum.forum"):forum>/user/<model("res.users"):user>/edit', type='http', auth="user", website=True)
508 def edit_profile(self, forum, user, **kwargs):
509 countries = request.env['res.country'].search([])
510 values = self._prepare_forum_values(forum=forum, searches=kwargs)
512 'email_required': kwargs.get('email_required'),
513 'countries': countries,
514 'notifications': self._get_notifications(),
516 return request.website.render("website_forum.edit_profile", values)
518 @http.route('/forum/<model("forum.forum"):forum>/user/<model("res.users"):user>/save', type='http', auth="user", methods=['POST'], website=True)
519 def save_edited_profile(self, forum, user, **kwargs):
521 'name': kwargs.get('name'),
522 'website': kwargs.get('website'),
523 'email': kwargs.get('email'),
524 'city': kwargs.get('city'),
525 'country_id': int(kwargs.get('country')) if kwargs.get('country') else False,
526 'website_description': kwargs.get('description'),
528 if request.uid == user.id: # the controller allows to edit only its own privacy settings; use partner management for other cases
529 values['website_published'] = kwargs.get('website_published') == 'True'
531 return werkzeug.utils.redirect("/forum/%s/user/%d" % (slug(forum), user.id))
534 # --------------------------------------------------
536 @http.route('/forum/<model("forum.forum"):forum>/badge', type='http', auth="public", website=True)
537 def badges(self, forum, **searches):
538 Badge = request.env['gamification.badge']
539 badges = Badge.sudo().search([('challenge_ids.category', '=', 'forum')])
540 badges = sorted(badges, key=lambda b: b.stat_count_distinct, reverse=True)
541 values = self._prepare_forum_values(forum=forum, searches={'badges': True})
545 return request.website.render("website_forum.badge", values)
547 @http.route(['''/forum/<model("forum.forum"):forum>/badge/<model("gamification.badge"):badge>'''], type='http', auth="public", website=True)
548 def badge_users(self, forum, badge, **kwargs):
549 users = [badge_user.user_id for badge_user in badge.sudo().owner_ids]
550 values = self._prepare_forum_values(forum=forum, searches={'badges': True})
555 return request.website.render("website_forum.badge_user", values)
558 # --------------------------------------------------
560 @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)
561 def convert_comment_to_answer(self, forum, post, comment, **kwarg):
562 post = request.env['forum.post'].convert_comment_to_answer(comment.id)
564 return werkzeug.utils.redirect("/forum/%s" % slug(forum))
565 question = post.parent_id if post.parent_id else post
566 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
568 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/convert_to_comment', type='http', auth="user", methods=['POST'], website=True)
569 def convert_answer_to_comment(self, forum, post, **kwarg):
570 question = post.parent_id
571 new_msg_id = post.convert_answer_to_comment()[0]
573 return werkzeug.utils.redirect("/forum/%s" % slug(forum))
574 return werkzeug.utils.redirect("/forum/%s/question/%s" % (slug(forum), slug(question)))
576 @http.route('/forum/<model("forum.forum"):forum>/post/<model("forum.post"):post>/comment/<model("mail.message"):comment>/delete', type='json', auth="user", website=True)
577 def delete_comment(self, forum, post, comment, **kwarg):
578 if not request.session.uid:
579 return {'error': 'anonymous_user'}
580 return post.unlink_comment(comment.id)[0]