]> Untitled Git - lemmy-ui.git/blob - src/shared/components/search.tsx
Adding simple scroll position restore. Fixes #18 (#162)
[lemmy-ui.git] / src / shared / components / search.tsx
1 import { Component, linkEvent } from 'inferno';
2 import { Subscription } from 'rxjs';
3 import {
4   UserOperation,
5   PostView,
6   CommentView,
7   CommunityView,
8   UserViewSafe,
9   SortType,
10   Search as SearchForm,
11   SearchResponse,
12   SearchType,
13   PostResponse,
14   CommentResponse,
15   Site,
16 } from 'lemmy-js-client';
17 import { WebSocketService } from '../services';
18 import {
19   wsJsonToRes,
20   fetchLimit,
21   routeSearchTypeToEnum,
22   routeSortTypeToEnum,
23   toast,
24   createCommentLikeRes,
25   createPostLikeFindRes,
26   commentsToFlatNodes,
27   setIsoData,
28   wsSubscribe,
29   wsUserOp,
30   wsClient,
31   authField,
32   setOptionalAuth,
33   saveScrollPosition,
34   restoreScrollPosition,
35 } from '../utils';
36 import { PostListing } from './post-listing';
37 import { HtmlTags } from './html-tags';
38 import { UserListing } from './user-listing';
39 import { CommunityLink } from './community-link';
40 import { SortSelect } from './sort-select';
41 import { CommentNodes } from './comment-nodes';
42 import { i18n } from '../i18next';
43 import { InitialFetchRequest } from 'shared/interfaces';
44
45 interface SearchProps {
46   q: string;
47   type_: SearchType;
48   sort: SortType;
49   page: number;
50 }
51
52 interface SearchState {
53   q: string;
54   type_: SearchType;
55   sort: SortType;
56   page: number;
57   searchResponse: SearchResponse;
58   loading: boolean;
59   site: Site;
60   searchText: string;
61 }
62
63 interface UrlParams {
64   q?: string;
65   type_?: SearchType;
66   sort?: SortType;
67   page?: number;
68 }
69
70 export class Search extends Component<any, SearchState> {
71   private isoData = setIsoData(this.context);
72   private subscription: Subscription;
73   private emptyState: SearchState = {
74     q: Search.getSearchQueryFromProps(this.props.match.params.q),
75     type_: Search.getSearchTypeFromProps(this.props.match.params.type),
76     sort: Search.getSortTypeFromProps(this.props.match.params.sort),
77     page: Search.getPageFromProps(this.props.match.params.page),
78     searchText: Search.getSearchQueryFromProps(this.props.match.params.q),
79     searchResponse: {
80       type_: null,
81       posts: [],
82       comments: [],
83       communities: [],
84       users: [],
85     },
86     loading: false,
87     site: this.isoData.site_res.site_view.site,
88   };
89
90   static getSearchQueryFromProps(q: string): string {
91     return decodeURIComponent(q) || '';
92   }
93
94   static getSearchTypeFromProps(type_: string): SearchType {
95     return type_ ? routeSearchTypeToEnum(type_) : SearchType.All;
96   }
97
98   static getSortTypeFromProps(sort: string): SortType {
99     return sort ? routeSortTypeToEnum(sort) : SortType.TopAll;
100   }
101
102   static getPageFromProps(page: string): number {
103     return page ? Number(page) : 1;
104   }
105
106   constructor(props: any, context: any) {
107     super(props, context);
108
109     this.state = this.emptyState;
110     this.handleSortChange = this.handleSortChange.bind(this);
111
112     this.parseMessage = this.parseMessage.bind(this);
113     this.subscription = wsSubscribe(this.parseMessage);
114
115     // Only fetch the data if coming from another route
116     if (this.state.q != '') {
117       if (this.isoData.path == this.context.router.route.match.url) {
118         this.state.searchResponse = this.isoData.routeData[0];
119         this.state.loading = false;
120       } else {
121         this.search();
122       }
123     }
124   }
125
126   componentWillUnmount() {
127     this.subscription.unsubscribe();
128     saveScrollPosition(this.context);
129   }
130
131   static getDerivedStateFromProps(props: any): SearchProps {
132     return {
133       q: Search.getSearchQueryFromProps(props.match.params.q),
134       type_: Search.getSearchTypeFromProps(props.match.params.type),
135       sort: Search.getSortTypeFromProps(props.match.params.sort),
136       page: Search.getPageFromProps(props.match.params.page),
137     };
138   }
139
140   static fetchInitialData(req: InitialFetchRequest): Promise<any>[] {
141     let pathSplit = req.path.split('/');
142     let promises: Promise<any>[] = [];
143
144     let form: SearchForm = {
145       q: this.getSearchQueryFromProps(pathSplit[3]),
146       type_: this.getSearchTypeFromProps(pathSplit[5]),
147       sort: this.getSortTypeFromProps(pathSplit[7]),
148       page: this.getPageFromProps(pathSplit[9]),
149       limit: fetchLimit,
150     };
151     setOptionalAuth(form, req.auth);
152
153     if (form.q != '') {
154       promises.push(req.client.search(form));
155     }
156
157     return promises;
158   }
159
160   componentDidUpdate(_: any, lastState: SearchState) {
161     if (
162       lastState.q !== this.state.q ||
163       lastState.type_ !== this.state.type_ ||
164       lastState.sort !== this.state.sort ||
165       lastState.page !== this.state.page
166     ) {
167       this.setState({ loading: true, searchText: this.state.q });
168       this.search();
169     }
170   }
171
172   get documentTitle(): string {
173     if (this.state.q) {
174       return `${i18n.t('search')} - ${this.state.q} - ${this.state.site.name}`;
175     } else {
176       return `${i18n.t('search')} - ${this.state.site.name}`;
177     }
178   }
179
180   render() {
181     return (
182       <div class="container">
183         <HtmlTags
184           title={this.documentTitle}
185           path={this.context.router.route.match.url}
186         />
187         <h5>{i18n.t('search')}</h5>
188         {this.selects()}
189         {this.searchForm()}
190         {this.state.type_ == SearchType.All && this.all()}
191         {this.state.type_ == SearchType.Comments && this.comments()}
192         {this.state.type_ == SearchType.Posts && this.posts()}
193         {this.state.type_ == SearchType.Communities && this.communities()}
194         {this.state.type_ == SearchType.Users && this.users()}
195         {this.resultsCount() == 0 && <span>{i18n.t('no_results')}</span>}
196         {this.paginator()}
197       </div>
198     );
199   }
200
201   searchForm() {
202     return (
203       <form
204         class="form-inline"
205         onSubmit={linkEvent(this, this.handleSearchSubmit)}
206       >
207         <input
208           type="text"
209           class="form-control mr-2 mb-2"
210           value={this.state.searchText}
211           placeholder={`${i18n.t('search')}...`}
212           onInput={linkEvent(this, this.handleQChange)}
213           required
214           minLength={3}
215         />
216         <button type="submit" class="btn btn-secondary mr-2 mb-2">
217           {this.state.loading ? (
218             <svg class="icon icon-spinner spin">
219               <use xlinkHref="#icon-spinner"></use>
220             </svg>
221           ) : (
222             <span>{i18n.t('search')}</span>
223           )}
224         </button>
225       </form>
226     );
227   }
228
229   selects() {
230     return (
231       <div className="mb-2">
232         <select
233           value={this.state.type_}
234           onChange={linkEvent(this, this.handleTypeChange)}
235           class="custom-select w-auto mb-2"
236         >
237           <option disabled>{i18n.t('type')}</option>
238           <option value={SearchType.All}>{i18n.t('all')}</option>
239           <option value={SearchType.Comments}>{i18n.t('comments')}</option>
240           <option value={SearchType.Posts}>{i18n.t('posts')}</option>
241           <option value={SearchType.Communities}>
242             {i18n.t('communities')}
243           </option>
244           <option value={SearchType.Users}>{i18n.t('users')}</option>
245         </select>
246         <span class="ml-2">
247           <SortSelect
248             sort={this.state.sort}
249             onChange={this.handleSortChange}
250             hideHot
251             hideMostComments
252           />
253         </span>
254       </div>
255     );
256   }
257
258   all() {
259     let combined: {
260       type_: string;
261       data: CommentView | PostView | CommunityView | UserViewSafe;
262       published: string;
263     }[] = [];
264     let comments = this.state.searchResponse.comments.map(e => {
265       return { type_: 'comments', data: e, published: e.comment.published };
266     });
267     let posts = this.state.searchResponse.posts.map(e => {
268       return { type_: 'posts', data: e, published: e.post.published };
269     });
270     let communities = this.state.searchResponse.communities.map(e => {
271       return {
272         type_: 'communities',
273         data: e,
274         published: e.community.published,
275       };
276     });
277     let users = this.state.searchResponse.users.map(e => {
278       return { type_: 'users', data: e, published: e.user.published };
279     });
280
281     combined.push(...comments);
282     combined.push(...posts);
283     combined.push(...communities);
284     combined.push(...users);
285
286     // Sort it
287     if (this.state.sort == SortType.New) {
288       combined.sort((a, b) => b.published.localeCompare(a.published));
289     } else {
290       combined.sort(
291         (a, b) =>
292           ((b.data as CommentView | PostView).counts.score |
293             (b.data as CommunityView).counts.subscribers |
294             (b.data as UserViewSafe).counts.comment_score) -
295           ((a.data as CommentView | PostView).counts.score |
296             (a.data as CommunityView).counts.subscribers |
297             (a.data as UserViewSafe).counts.comment_score)
298       );
299     }
300
301     return (
302       <div>
303         {combined.map(i => (
304           <div class="row">
305             <div class="col-12">
306               {i.type_ == 'posts' && (
307                 <PostListing
308                   key={(i.data as PostView).post.id}
309                   post_view={i.data as PostView}
310                   showCommunity
311                   enableDownvotes={this.state.site.enable_downvotes}
312                   enableNsfw={this.state.site.enable_nsfw}
313                 />
314               )}
315               {i.type_ == 'comments' && (
316                 <CommentNodes
317                   key={(i.data as CommentView).comment.id}
318                   nodes={[{ comment_view: i.data as CommentView }]}
319                   locked
320                   noIndent
321                   enableDownvotes={this.state.site.enable_downvotes}
322                 />
323               )}
324               {i.type_ == 'communities' && (
325                 <div>{this.communityListing(i.data as CommunityView)}</div>
326               )}
327               {i.type_ == 'users' && (
328                 <div>{this.userListing(i.data as UserViewSafe)}</div>
329               )}
330             </div>
331           </div>
332         ))}
333       </div>
334     );
335   }
336
337   comments() {
338     return (
339       <CommentNodes
340         nodes={commentsToFlatNodes(this.state.searchResponse.comments)}
341         locked
342         noIndent
343         enableDownvotes={this.state.site.enable_downvotes}
344       />
345     );
346   }
347
348   posts() {
349     return (
350       <>
351         {this.state.searchResponse.posts.map(post => (
352           <div class="row">
353             <div class="col-12">
354               <PostListing
355                 post_view={post}
356                 showCommunity
357                 enableDownvotes={this.state.site.enable_downvotes}
358                 enableNsfw={this.state.site.enable_nsfw}
359               />
360             </div>
361           </div>
362         ))}
363       </>
364     );
365   }
366
367   communities() {
368     return (
369       <>
370         {this.state.searchResponse.communities.map(community => (
371           <div class="row">
372             <div class="col-12">{this.communityListing(community)}</div>
373           </div>
374         ))}
375       </>
376     );
377   }
378
379   communityListing(community_view: CommunityView) {
380     return (
381       <>
382         <span>
383           <CommunityLink community={community_view.community} />
384         </span>
385         <span>{` - 
386         ${i18n.t('number_of_subscribers', {
387           count: community_view.counts.subscribers,
388         })}
389       `}</span>
390       </>
391     );
392   }
393
394   userListing(user_view: UserViewSafe) {
395     return [
396       <span>
397         <UserListing user={user_view.user} showApubName />
398       </span>,
399       <span>{` - ${i18n.t('number_of_comments', {
400         count: user_view.counts.comment_count,
401       })}`}</span>,
402     ];
403   }
404
405   users() {
406     return (
407       <>
408         {this.state.searchResponse.users.map(user => (
409           <div class="row">
410             <div class="col-12">{this.userListing(user)}</div>
411           </div>
412         ))}
413       </>
414     );
415   }
416
417   paginator() {
418     return (
419       <div class="mt-2">
420         {this.state.page > 1 && (
421           <button
422             class="btn btn-secondary mr-1"
423             onClick={linkEvent(this, this.prevPage)}
424           >
425             {i18n.t('prev')}
426           </button>
427         )}
428
429         {this.resultsCount() > 0 && (
430           <button
431             class="btn btn-secondary"
432             onClick={linkEvent(this, this.nextPage)}
433           >
434             {i18n.t('next')}
435           </button>
436         )}
437       </div>
438     );
439   }
440
441   resultsCount(): number {
442     let res = this.state.searchResponse;
443     return (
444       res.posts.length +
445       res.comments.length +
446       res.communities.length +
447       res.users.length
448     );
449   }
450
451   nextPage(i: Search) {
452     i.updateUrl({ page: i.state.page + 1 });
453   }
454
455   prevPage(i: Search) {
456     i.updateUrl({ page: i.state.page - 1 });
457   }
458
459   search() {
460     let form: SearchForm = {
461       q: this.state.q,
462       type_: this.state.type_,
463       sort: this.state.sort,
464       page: this.state.page,
465       limit: fetchLimit,
466       auth: authField(false),
467     };
468
469     if (this.state.q != '') {
470       WebSocketService.Instance.send(wsClient.search(form));
471     }
472   }
473
474   handleSortChange(val: SortType) {
475     this.updateUrl({ sort: val, page: 1 });
476   }
477
478   handleTypeChange(i: Search, event: any) {
479     i.updateUrl({
480       type_: SearchType[event.target.value],
481       page: 1,
482     });
483   }
484
485   handleSearchSubmit(i: Search, event: any) {
486     event.preventDefault();
487     i.updateUrl({
488       q: i.state.searchText,
489       type_: i.state.type_,
490       sort: i.state.sort,
491       page: i.state.page,
492     });
493   }
494
495   handleQChange(i: Search, event: any) {
496     i.setState({ searchText: event.target.value });
497   }
498
499   updateUrl(paramUpdates: UrlParams) {
500     const qStr = paramUpdates.q || this.state.q;
501     const qStrEncoded = encodeURIComponent(qStr);
502     const typeStr = paramUpdates.type_ || this.state.type_;
503     const sortStr = paramUpdates.sort || this.state.sort;
504     const page = paramUpdates.page || this.state.page;
505     this.props.history.push(
506       `/search/q/${qStrEncoded}/type/${typeStr}/sort/${sortStr}/page/${page}`
507     );
508   }
509
510   parseMessage(msg: any) {
511     console.log(msg);
512     let op = wsUserOp(msg);
513     if (msg.error) {
514       toast(i18n.t(msg.error), 'danger');
515       return;
516     } else if (op == UserOperation.Search) {
517       let data = wsJsonToRes<SearchResponse>(msg).data;
518       this.state.searchResponse = data;
519       this.state.loading = false;
520       window.scrollTo(0, 0);
521       this.setState(this.state);
522       restoreScrollPosition(this.context);
523     } else if (op == UserOperation.CreateCommentLike) {
524       let data = wsJsonToRes<CommentResponse>(msg).data;
525       createCommentLikeRes(
526         data.comment_view,
527         this.state.searchResponse.comments
528       );
529       this.setState(this.state);
530     } else if (op == UserOperation.CreatePostLike) {
531       let data = wsJsonToRes<PostResponse>(msg).data;
532       createPostLikeFindRes(data.post_view, this.state.searchResponse.posts);
533       this.setState(this.state);
534     }
535   }
536 }