From ef07a797e24a7b44827b816ea0d797bf77da6978 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sun, 21 Mar 2021 14:31:51 -0700 Subject: [PATCH 01/11] Copies over the production README --- README.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 10f77c04..e6a75375 100644 --- a/README.md +++ b/README.md @@ -213,17 +213,6 @@ Congrats! You did it, go to your domain and enjoy the fruits of your labors. ``` - Go to the site settings (`/settings/site-settings` on your domain) and configure your instance name, description, code of conduct, and toggle whether registration is open on your instance - -## Book data -The application is set up to share book and author data between instances, and get book data from arbitrary outside sources. Right now, the only connector is to OpenLibrary, but other connectors could be written. - -There are three concepts in the book data model: -- `Book`, an abstract, high-level concept that could mean either a `Work` or an `Edition`. No data is saved as a `Book`, it serves as shared model for `Work` and `Edition` -- `Work`, the theoretical umbrella concept of a book that encompasses every edition of the book, and -- `Edition`, a concrete, actually published version of a book - -Whenever a user interacts with a book, they are interacting with a specific edition. Every work has a default edition, but the user can select other editions. Reviews aggregated for all editions of a work when you view an edition's page. - ### Backups BookWyrm's db service dumps a backup copy of its database to its `/backups` directory daily at midnight UTC. @@ -238,6 +227,15 @@ You can copy backups from the backups volume to your host machine with `docker c - Run `docker-compose ps` to confirm the db service's full name (it's probably `bookwyrm_db_1`. - Run `docker cp :/backups ` +### Updating your instance + +When there are changes available in the production branch, you can install and get them running on your instance using the command `./bw-dev update`. This does a number of things: +- `git pull` gets the updated code from the git repository. If there are conflicts, you may need to run `git pull` separately and resolve the conflicts before trying the `./bw-dev update` script again. +- `docker-compose build` rebuilds the images, which ensures that the correct packages are installed. This step takes a long time and is only needed when the dependencies (including pip `requirements.txt` packages) have changed, so you can comment it out if you want a quicker update path and don't mind un-commenting it as needed. +- `docker-compose exec web python manage.py migrate` runs the database migrations in Django +- `docker-compose exec web python manage.py collectstatic --no-input` loads any updated static files (such as the JavaScript and CSS) +- `docker-compose restart` reloads the docker containers + ### Port Conflicts BookWyrm has multiple services that run on their default ports. @@ -317,3 +315,14 @@ To set up your server: - restart nginx If everything worked correctly, your BookWyrm instance should now be externally accessible. + + +## Book data +The application is set up to share book and author data between instances, and get book data from arbitrary outside sources. Right now, the only connector is to OpenLibrary, but other connectors could be written. + +There are three concepts in the book data model: +- `Book`, an abstract, high-level concept that could mean either a `Work` or an `Edition`. No data is saved as a `Book`, it serves as shared model for `Work` and `Edition` +- `Work`, the theoretical umbrella concept of a book that encompasses every edition of the book, and +- `Edition`, a concrete, actually published version of a book + +Whenever a user interacts with a book, they are interacting with a specific edition. Every work has a default edition, but the user can select other editions. Reviews aggregated for all editions of a work when you view an edition's page. From ad8baa9122e90d3b6b28579f3d6a947ec4ec054f Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sun, 21 Mar 2021 14:32:18 -0700 Subject: [PATCH 02/11] Adds compiled german translations --- locale/de_DE/LC_MESSAGES/django.mo | Bin 24140 -> 26527 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/locale/de_DE/LC_MESSAGES/django.mo b/locale/de_DE/LC_MESSAGES/django.mo index 40fbee8d9c94aee1ae58b831cb6482f9801e9893..61a659d88d5d224d5972244a1911861061102464 100644 GIT binary patch delta 10033 zcmb8!2Xs|czQ^$s=~W=~dPqp4B=i#LJwT`dq;r#dl6%c9;TD1@TogMh%C%uceb}*} zW^BNWDD#|$Is$e?85Kp}2&m6Oah@~Z-#r_JwceVw-dXd{XYYOX*=N_2;Jmpj?Y@0! ziNmex-fnTl(k!bp?rLILKagJBPNkNW+s(3~n1@&67Hp20wq^Ci{@4bWU?+@XU)+cn z;%-z^`>_jtjU`yWyJcltR>E3DLN~5NHFQ5_;Pc4;tb?Zf7wka3B{v6RFI2P31v&1?KU7>je_&6nus)@h7a04YDk&AvVW4*bWG4QMU)$NRAX@3-C|p$86OEBqYm;!mg-ok3Q`YRr5! z!?vjVJ+KAl;Wb!@8o(>4rFaL`fp4)s{sYxsogBA39TTcxlchNw<`){J2KWNIoG36(7n1A+@RX5jtVGq=Uy-__KYVwm& z4VR!^REn+9k9xscbAJPBPi)5a_zY?$UPskCicEs_1FHRwdCdP%5-wMTWR8>*c|0SR?rm?@ZS^0QG7 zdQekdjcRx;YByhN%4@JO`K_oKdlET;)=qQ(u<=XO3>`z&JB>|r{u}gmN0N@}Sr+P? z4??|ghAF=o)gd3MfwicP--w!t8gu_i)J*O{9k(}-{bn6UJ=dm>`<_f(r1L+(6l_E_ zcpuU;>nW4pfjS*~Q6t}n+I&Y$`6<*4{fc^Vy?poiW~h1{uqo!FHseLu9Op}&|8f!< zY23ILb*!#MHE=hof$hd!*o^#M)OX+m)C_!#dhP@^$Fu@A7`8zAW)+zH5>)-mF`-Rx zvnjX>^}=nap1zD~;1H_b8PtpG@_|=}TA@bV4Rt>UHIRNtAFM*u%=u9r4Wo`_3^ijn z^=1C`;B6GB;d@a%djd7pe=-%{Mm2B{_2R>*7kz^o>5q6J*6GLo!E{u|h8f48>K9>4 zoQ-;~w;%Jbo`g(69D9&Ypl0AfRKvSbBiWB?_8sE+-B8i+pd$~Q-Ku#?I6 zG!8*+^6?20dSEH4BLUQLilSb)7Wu_xU4?4sQR54!j=YB2tZ$*7{|MEg&rJR(>bc{n zrThoB#7+a;4kY@J=tjXLY=IT14y?j-TyMM+^T1c?jJ;T=qqfCKci->*$|E;@3%UTn1Yjxo3I`EPp~!qgc^Bceq-oQv@SRn3sLvi zpq6YCYR_yz4d4Mx%>b$cJ5U|mYkV6MDmX+!BlyDH_#V~Z8Po{t4Ri0OV>)>ovvHs) zUxbL%rZfya*feLmeBB>d-8c zUu^PzV+_?`!rZ?dH4|G=9eWgu@oAinznXmUaOPht_;|Q_y(=e`MfhT!Sqqx|?SsYRXR_gSAFZ;vXfr7PVI%G44doG%vfHuF*oOC8`6RRn$D`K11T_Pts0X5GoO9W!loR79@riA;6!YMC8!Q9MV;d?YICl|#<&61 zp*u|ZR+Hb3YIi4U?e}AEJc|0Bq)%o3^@3~?>QP@z&4jT8^~Lg<{AI=ssE*d4p5Kj4 z@O4!E_f7sd>i%ieOx2m@?xm)vf#gnO{x#Ae6llsOpmz6C%)nKs`!$$@kD)fz0py!v z9YHnRrPv)nHZ~<+h?=oUsF7ZbdSNAMfUC{@8;Y5KRj4rqPoZA$GHU7$nDV38h5Sk6 z+hn!jE20KxqB^h)8>0_3;wY*kYf$anVD8^%^4l<*@|P1N)PbYe3{Rt$q5)f8$E*|9 z$DyeEqfjp_Ms;)^Hb5V$ohsDx>roxJ6Vbp*1^*z3@BK3p>wr z*EAE=U;(PZao7T9qBfNW)sbpcz3Wjg+=6=HqsHB+nfMT!;BhyfuuhZEgUx5TH!`p% z`FzaB1*nl-hiae(%kgQ{3);5>F+=jcOrgAW9^NvP6w-B{tD^Md&;DxvW)v+4vp!2_# zgm(Wf)PwJ#cKb0bz}6-1Cv`lk-X*98*P~`&qbYv`v&rwq-uM+Z$JTS*8OcN~;b7Dr z7>B9zKb3?=J{SAqa@3dVR@7A8f!h7|pdQ?T8u6>x2H(V%_&Mr##gC}xTg-DeYa7&v zyP}@YLOs`K9`monI0^>f0#orO<87#s)?jOV1T}(PrhG4IO5a26l`m1>jn?zsnHqvR zEi+N|7GPWSqdKx~KJ%{%*HNGm-HMvB8q`{ELp`_?wU%$7jR#R3JA-AS77N~~1 zqP~#X*bb+nUR;KniPfh3iUbLDU^A+rt*9w~0@aacu^YaEYTz@p@f7L>9TvFdBT*fl zYw`}JlfN7b@D|hncB4A*7HY{8?~#a*_!PCqa~8TITY-9D4YtA!s0Z&g`G-(5^dhR> zUd+J{FdP4gTB>aRXlRcEP#v0vTB7CHi}zdWNoWSPqZ)eA_!_F>yQs}|5;a4O7P}3l zV@L8isE&nKP?wU74jU*kl+dHCO zT!0$+6x5oPpr(EqszX(%nY+s5H=$neFlrC|(d6GmosuJ{_FFAy{?%X(303TmGjI%g z@mACWKVv3ldECGGicp))hkOjJRj3!ff&4jWeU7QMFLfPY9F6K|vB@tgW&YI@pD9>_ zTC*Ear(hHEEwS#xS$G2H;pj5=&*?j{4*C740lbTP@eySIS>K`RPh~X9Z^hyGzo?EB zIth1bCp+#Ro3oL9W<7(UPpEK9g{y~`~tOP$FV-1#7z7Z zeV9?l30W1rzXH6>xpvV&zkQu_|+EA83!XH~AMyZzGlyx<(U4 z#1P_Vg1v41C!y;P1mkxLRwSPT>9N~AtM8_1m^3V*+m`fvG-$zMnLa%9P@adpRO*kp9wMRX_q zDF*R=OcJ{46Z%Kxv{a7cgJXy?lNTq6BZP-~J&5mA$n_a<12JD2b4}yE-%Tg1C>dSf z5YG^w6E>j_i_YkO6S_JPg~UE(%r(WBjYm!T1nSH`NVFm*)BYCJ)sS?5;%d@26D9hq zVEXQ6@c=+5-q(n_R4U>L zYsy6z@*RmUNbevnA)X?1{SR>mF-IA$9z+xBb|XI2xjjHZS2BOXIj9fv^@OhPiFb$w zl>b8oTt5+Mk(otkxTw{?1XKxXBzuFzQHbCt8x9h+h-m61u90w}_ksH|rA1 zRLb?Zi&aJ0P||VYazY>T4wSVZR+FxSe&R;bV=xnS9d}9n_IT8!cN#CG-V)LkCNC0s z6uwF#gjbpy8KiZ!#!CDsmE+G-%pgV*{fS?QIs}_9b+zN?Z6^Jtu^zT2vS=#{|BDz- z=o+g@8sw%^zxR}U+T=y=bJF8U&!v&Cush);y^vT*x|q<_nYc$%eladWT^HeGydsrz ze>{+aMS8;&W>RUGNjEaq#le&hCv=r!0kPT5TK~kEx@YdUH03j}FJ(0*Ux3-B&ZVSB zm~?8BEHRn(rt-(=Bl?+qb94V?@(%GNF_5yqVAbbRqA-m=h&s;SS%b=UF8C_syk69;FOV~C@Z(z;}1CAWo6-bD3%ws{V^vP zwX1#pGN0|<(i8rmW-CA0zUTZ_9a@(4}GBZ0zXpy#F*so4uh>~Y~>&r>f$m zbk^rY@}l|HOq22c+k1Mv(3%zJjn-_ZPq@kn;d!&2+}CGwcMZhO%*u7wb(!Cr7uA|+ zHQW_QI{Dq}MZu^d_ggwED>uplEpt0+vkT7I+0l5F#i5wF9^d~VFcY3&!rBYSpnI#IGrql6N$#0K)?x|b5y75sOm*JtWIb}TotV8@z`o7^^Di?RB~*o!CQ7r z7+Y__gwzpL*UmY*rQG+&n9OtDr^6ewy{xXIu}?6^SDC22G92-FLJWdo%y%M{PIOfA zmnppxL3;wFj4onNddm|e1T}0 zFA%Tj%_l0lI$pi!K_8>fw-(0PXscr^r6*EKzuC7d!=XZJwkJ7q>ZI1=Qiq%pd+zLM zcECd~3zJt(eXhOxp-fFC{jPM+yC>q*4w=>_t+iuM56Aqg>41k0S2(4-Dmke*tNql} z_{Z|1R5$GkC&+p`vD(Vw>Gcvo+_dA-5)Wh`koE7DSYDJSz&Um7S*+BpPt57wwT{1kgL)~e6o{!dEJ+oC> zpJIn!DiOz?%=)qw^^LIk&7ecGXBWpIR6Dq2Tv{%t$|;QecBriJenzBUFD!EE zd`DCJIX}5-ZjXs)PbgoGh=!Tkz{TfpBeR0%e%`9JC;5i4OZ`qPzxIx~&o}%R##|S8 delta 7725 zcmZwMd0bUx9>?)>RTLCZKoBGlQE^37T)6lyBEz7iV zsmw9!T8&GkO^s>hQrT{1)?}JxnQJ=D=X=ku*ULZVy!!Eee$RQ%vz>D;S6X}6b8xrE z`*mcs-S4=8VmR;}ZFLuCb?#JM;u!EwUzOKgE>P)(x~9VZ@JVjJv- zwQ(BO!+A(kXC3C_o0#G_UMH%7d!jR{qY;>l<=7CHTD>3R$oFG=Jca5wHpy`sV;j5= zhneqUIe7;<$-@oU1Fv9n%w&)##&^b0h@fIBR>%1mj7zX8K8Yc?2DPH+EPoxf6ML}+ z9zk9I8HVBsjKZH#3vn7bPCH0OwI7Dn8Q&RAArecl8cxMpI32@qp4G3wI^<8`qqqe% z@pP82t?z>xxEM8&a@2$?t$wcg1O`#R7QJe?k%DHl#oUhScsFXR4xuJ^1=YS*6L(^f zsEH<_25yDAF4O9>t-b)&e~HzPH>WjW|Fyz7RH)-8ur5A{>ToOS{4UhJ-jA_(61C!M zsCF?afrrUygj(@H%)r}G1N*H0DO7(iTD~KN{nrZiQ=xl&%sgTKh#KGm@?tnnQ#Y@L z8YmW3-wf+xI%?n?)U)vz*1#3!Gv+4L`K?|nyn&j)LDUw0f=PJV&WAK}AIezNGtdzA zwzR|Q*dH~aTvR`Ipav+je46F6QP(X+UFUs{LNJA`sHgRHJMlhhWgnup>^SluJ7?{D zI1h$8h(_(uEvRG`~cx{1$8_I`BZc!V=6AS{4ES2 z{~C4SX$(C5c0Q(+d%go|pzf#%3_>mJcGUHEp(Z>YTVo}9wKW?kXl9#Huh&bcd;1>h z!o#SJKSxdA2h>(xMYRiKwz|G9hGHCQpcK@?(onak8}i0FIjD(ENoD_4m`;T*n1dQ% zA!^{Yr~zKEd>g8xov4W)Kn;8ZHSjSE!*4A=kD9;@%R^aqV1lTJF{L&8uM2ump@DL+ zCJsXla3_Z2ShEsqkB8cx7DsE&R^?OY_kb7efLePgo~)*)|?+R;8{F6wpmj-(K{1*p&X zIj9|3iA`}M@|-yzpeA$`Yh!R*cLK4f_8F*t`l8O~pe9s=8u)I@C!t>V2a)z(X9)#$ zunKi=HlZ%`Tm5d-zy~k}KS%Avc}&IYI1pR#yH!@Aepl>4eWCdb^;%v;-P)Sz?yZf+ z!22IhK{HN94b%=bfu80-GY>VvQI?mXI-HDJzzjRT0HerPVG3@s`j1dM^bKmf(>Pe~ z{}l>FIH0}z1>t$rz5NokRezu^i0I(1upvf~kH=eaCTe24Q4`v4`Nx)@G=IWq&R<5g z59?^}e|-v?SrQJyW|)KbTmCMxdrnj*$EkvSQ7ayR>Zkw*V~P1H=8{+ES0QtEhNE_L z0jm8n%*SUlxc@3#q9PBoGu>aGYcZ1iGt_H%7S+M8sEJ-fy?#|XyY(SvB&t3h<1iWT z#4f1o)}Z>?h*Y;iPfl2!o6M!8sGJh2 zg9i@hV-eQq>2CR0Y)1YX>KQpK2R!96PbZ}Z5N>)t~IE)U^8kWuUh?H%MYOz_64?LeCIp`J!}bm z+>YCzCej(T@*J}WW5~-bpKC5hO=u%(z?aNjR=*Fm^+!?9$QP&yU&1iPcY^x5TN#CV zYFlA4_C>9@44dLq)U8>Iya3M2sE*H~Cj2{U2ZH;#I}?psSPE*uOw@w<+xZdbRf96C zn2s7?A!_T_TK#rRAb%HmbDUGC4io#k6G%mEc}LVv^h8Z08`aMUJ3qnlX_!L&!v5^P zCa|3ft#lu1CC5;&&yQFgs}FF`hhZ>zJZhqiu?BWT_0tV?{SedyN-^*eje1RIpxQ6T z5L`2W{ntHxj*6D}CThSlsC)S2(o4kHG-Tbqb_h|*9K>4R!lfHm=6)PVP!i%>hU z3Dxf|%lCOH=)$k;#Cg<8u3LlJ*=|RTF^KvusPDClH$Lp^MJP%A!+q4+K8UjBlb;APYbJvr_l zAVRSkc~{hqWT777{;2E5Vu;@Vathj#X{dX-2=$(>Lv^qlwUv8OD?EVe;3(?4&&^*j zojfSlZI@~GK{ER{9Qx;~~^7JC3#S zXAHytViJZ9b_Y&HU6+YE-wW065cF!xM^ex|nuN;dp(d~nb>R!BE%c)X-hmD9J=Arl zF$w>~#+Wq3t?z@H*eJ`#qaNNzP!m}>g#Fi+Zlpr@ZVOJv*HQPX#ZY@TP#5H5B;JL( zuF~@9SciNus@*zlid#`z{RwJkPoXAo9rX!YCy)JaNg+MYz3>im0;<777=h2Ac48Yw z;ZD>94x#StG1QixMD56rR(0l+j;7Zg)wxVv;PSgbVU|rmY>i;X$LN23r-0Kixe&K@Umv2*=^J zI887Hry*YfoW-bn_>uXIc@8zvYnBI(bSDyxYTp8NOFE%;q&u=`rw{UYIZxqmz5nMZ zWKhxjcK7dnGf*p-h3aSt@}IMYA1ubXVtFoK^tzC5Mor`g)Ye`^eI@%7`OhgD#h+tv zC-%Vlquq%XV&Lz86DjC*n~Iw8Ov~q)OHm!KM%~j5s4aXE$Kher)@LxP`ssxpY^@(0 zk;Hl86{03}Poa+SgtsRZLDsOp`AOikJDFtaUb9@!$6?}A;@?*HGFG+gKBs&ykwG45 zbzhU~!A&PRTir6sIy&qAkDzjrn>(?TPg*(J{C{XWbu4fR{N49$%JYd_`eD73XC$-Emk6YmjU z5toVgiM1NPf^|b34M!5}!*ty>+>lJ&8=uHf!z6t)9(D5%~O`ybY zJ-bF}L&_gny*@1i-~TsRMIHPP5l*AV#5JoAyi1gaTSwnh&L*BE#u4$v4MHDcd=@#u zv};EEMmdzILHPjgCu$NM$aVZ(KeYdKtwQ-${orUvoezf+*_7*IJz@y)*D;#HqeM62 zb|Qj!fq0X+i%2A1CH_I&NmL=4+gNq*A#(2we(WYD6M0ld6Q5Dmaf!G>Xp+^apNSFJ zl4wA5AkRV_ei!FYj3Js6`c%}>gIKNtN4~ZHf^sbnU8hp9l%zk=hH_Kl8_ItW|0ISH zI=@_qC1)h~XJ_mV_dnckqsQN6fY;+YGVp!hp6nR^x$K@nzIj7h_~M4%;afO# zyT33m%Hw-1Kgqu*zeyF(a9>hxtZ#5Zh;L@WCSUf5H2 Date: Sun, 21 Mar 2021 12:53:30 -0700 Subject: [PATCH 03/11] Lets users opt in to directory --- bookwyrm/migrations/0057_user_discoverable.py | 19 +++++++++++++++++++ bookwyrm/models/user.py | 1 + 2 files changed, 20 insertions(+) create mode 100644 bookwyrm/migrations/0057_user_discoverable.py diff --git a/bookwyrm/migrations/0057_user_discoverable.py b/bookwyrm/migrations/0057_user_discoverable.py new file mode 100644 index 00000000..522f0869 --- /dev/null +++ b/bookwyrm/migrations/0057_user_discoverable.py @@ -0,0 +1,19 @@ +# Generated by Django 3.1.6 on 2021-03-21 21:44 + +import bookwyrm.models.fields +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('bookwyrm', '0056_auto_20210321_0303'), + ] + + operations = [ + migrations.AddField( + model_name='user', + name='discoverable', + field=bookwyrm.models.fields.BooleanField(default=False), + ), + ] diff --git a/bookwyrm/models/user.py b/bookwyrm/models/user.py index 46f08509..84391e10 100644 --- a/bookwyrm/models/user.py +++ b/bookwyrm/models/user.py @@ -103,6 +103,7 @@ class User(OrderedCollectionPageMixin, AbstractUser): last_active_date = models.DateTimeField(auto_now=True) manually_approves_followers = fields.BooleanField(default=False) show_goal = models.BooleanField(default=True) + show_in_directory = models.BooleanField(default=False) name_field = "username" From 3e75253ff179842dc4942f5acb21e49e6d09dd59 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sun, 21 Mar 2021 14:50:36 -0700 Subject: [PATCH 04/11] Updates activitpub and tests for discoverability --- bookwyrm/activitypub/person.py | 2 +- bookwyrm/models/user.py | 2 +- bookwyrm/templates/layout.html | 2 +- bookwyrm/tests/data/ap_user.json | 3 +++ bookwyrm/tests/views/test_inbox.py | 1 + 5 files changed, 7 insertions(+), 3 deletions(-) diff --git a/bookwyrm/activitypub/person.py b/bookwyrm/activitypub/person.py index f1298b92..dafd1910 100644 --- a/bookwyrm/activitypub/person.py +++ b/bookwyrm/activitypub/person.py @@ -30,5 +30,5 @@ class Person(ActivityObject): icon: Image = field(default_factory=lambda: {}) bookwyrmUser: bool = False manuallyApprovesFollowers: str = False - discoverable: str = True + discoverable: str = False type: str = "Person" diff --git a/bookwyrm/models/user.py b/bookwyrm/models/user.py index 84391e10..c2a74c63 100644 --- a/bookwyrm/models/user.py +++ b/bookwyrm/models/user.py @@ -103,7 +103,7 @@ class User(OrderedCollectionPageMixin, AbstractUser): last_active_date = models.DateTimeField(auto_now=True) manually_approves_followers = fields.BooleanField(default=False) show_goal = models.BooleanField(default=True) - show_in_directory = models.BooleanField(default=False) + discoverable = fields.BooleanField(default=False) name_field = "username" diff --git a/bookwyrm/templates/layout.html b/bookwyrm/templates/layout.html index c7d10b57..b25bef45 100644 --- a/bookwyrm/templates/layout.html +++ b/bookwyrm/templates/layout.html @@ -107,7 +107,7 @@ {% endif %} {% if perms.bookwyrm.create_invites %}
  • - + {% trans 'Invites' %}
    • diff --git a/bookwyrm/tests/data/ap_user.json b/bookwyrm/tests/data/ap_user.json index b159ae65..bc4488e3 100644 --- a/bookwyrm/tests/data/ap_user.json +++ b/bookwyrm/tests/data/ap_user.json @@ -28,6 +28,9 @@ }, "bookwyrmUser": true, "manuallyApprovesFollowers": false, + "discoverable": true, + "devices": "https://friend.camp/users/tripofmice/collections/devices", + "tag": [], "icon": { "type": "Image", "mediaType": "image/png", diff --git a/bookwyrm/tests/views/test_inbox.py b/bookwyrm/tests/views/test_inbox.py index b681b961..10f55f89 100644 --- a/bookwyrm/tests/views/test_inbox.py +++ b/bookwyrm/tests/views/test_inbox.py @@ -789,6 +789,7 @@ class Inbox(TestCase): self.assertEqual(user.name, "MOUSE?? MOUSE!!") self.assertEqual(user.username, "mouse@example.com") self.assertEqual(user.localname, "mouse") + self.assertTrue(user.discoverable) def test_handle_update_edition(self): """ update an existing edition """ From ba00672e66b19987c83897625f8fadd438422955 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sun, 21 Mar 2021 16:37:52 -0700 Subject: [PATCH 05/11] Directory view --- bookwyrm/forms.py | 4 +- bookwyrm/templates/directory.html | 67 +++++++++++++++++++ bookwyrm/templates/edit_author.html | 4 +- bookwyrm/templates/preferences/edit_user.html | 8 +++ bookwyrm/templates/snippets/avatar.html | 2 +- bookwyrm/urls.py | 1 + bookwyrm/views/__init__.py | 1 + bookwyrm/views/directory.py | 32 +++++++++ bookwyrm/views/landing.py | 2 +- 9 files changed, 115 insertions(+), 6 deletions(-) create mode 100644 bookwyrm/templates/directory.html create mode 100644 bookwyrm/views/directory.py diff --git a/bookwyrm/forms.py b/bookwyrm/forms.py index d330211c..4e92b32e 100644 --- a/bookwyrm/forms.py +++ b/bookwyrm/forms.py @@ -3,7 +3,6 @@ import datetime from collections import defaultdict from django import forms -from django.core.exceptions import ValidationError from django.forms import ModelForm, PasswordInput, widgets from django.forms.widgets import Textarea from django.utils import timezone @@ -130,8 +129,9 @@ class EditUserForm(CustomForm): "name", "email", "summary", - "manually_approves_followers", "show_goal", + "manually_approves_followers", + "discoverable", ] help_texts = {f: None for f in fields} diff --git a/bookwyrm/templates/directory.html b/bookwyrm/templates/directory.html new file mode 100644 index 00000000..9323752f --- /dev/null +++ b/bookwyrm/templates/directory.html @@ -0,0 +1,67 @@ +{% extends 'layout.html' %} +{% load i18n %} +{% load bookwyrm_tags %} +{% load humanize %} + +{% block title %}{% trans "Directory" %}{% endblock %} + +{% block content %} +
    +

    + {% trans "Directory" %} +

    +
    +
    + {% for user in users %} +
    +
    +
    +
    + + {% include 'snippets/avatar.html' with user=user large=True %} + +
    + + {{ user.display_name }} + @{{ user|username }} + + {% include 'snippets/follow_button.html' with user=user %} +
    +
    + + {% if user.summary %} +
    + {{ user.summary | to_markdown | safe | truncatechars_html:40 }} +
    + {% endif %} +
    +
    +
    +
    +

    {{ user.shelfbook_set.count }}

    +

    {% trans "books shelved" %}

    +
    +
    +
    +
    +

    {{ user.status_set.count|intword }}

    +

    {% trans "posts" %}

    +
    +
    +
    +
    +

    {{ user.last_active_date|naturalday }}

    +

    {% trans "last active" %}

    +
    +
    +
    +
    +
    + {% endfor %} +
    + +
    + {% include 'snippets/pagination.html' with page=users path="/directory" %} +
    + +{% endblock %} diff --git a/bookwyrm/templates/edit_author.html b/bookwyrm/templates/edit_author.html index 0316a66f..542b57f9 100644 --- a/bookwyrm/templates/edit_author.html +++ b/bookwyrm/templates/edit_author.html @@ -2,11 +2,11 @@ {% load i18n %} {% load humanize %} -{% block title %}{% trans "Edit Author" %}: {{ author.name }}{% endblock %} +{% block title %}{% trans "Edit Author:" %} {{ author.name }}{% endblock %} {% block content %}
    -

    +

    Edit "{{ author.name }}"

    diff --git a/bookwyrm/templates/preferences/edit_user.html b/bookwyrm/templates/preferences/edit_user.html index ca0f81c2..327d745b 100644 --- a/bookwyrm/templates/preferences/edit_user.html +++ b/bookwyrm/templates/preferences/edit_user.html @@ -53,6 +53,14 @@ {{ form.manually_approves_followers }}
    +
    + + {% url 'directory' as path %} +

    {% blocktrans %}Your account will show up in the directory, and may be recommended to other BookWyrm users.{% endblocktrans %}

    +
    {% endblock %} diff --git a/bookwyrm/templates/snippets/avatar.html b/bookwyrm/templates/snippets/avatar.html index 6d27cd85..d53acf2b 100644 --- a/bookwyrm/templates/snippets/avatar.html +++ b/bookwyrm/templates/snippets/avatar.html @@ -1,3 +1,3 @@ {% load bookwyrm_tags %} -{{ user.alt_text }} +{{ user.alt_text }} diff --git a/bookwyrm/urls.py b/bookwyrm/urls.py index 4aced6fe..76622799 100644 --- a/bookwyrm/urls.py +++ b/bookwyrm/urls.py @@ -96,6 +96,7 @@ urlpatterns = [ path("", views.Home.as_view(), name="landing"), re_path(r"^discover/?$", views.Discover.as_view()), re_path(r"^notifications/?$", views.Notifications.as_view()), + re_path(r"^directory/?", views.Directory.as_view(), name="directory"), # feeds re_path(r"^(?Phome|local|federated)/?$", views.Feed.as_view()), re_path( diff --git a/bookwyrm/views/__init__.py b/bookwyrm/views/__init__.py index 3402e65f..f1ebfc4c 100644 --- a/bookwyrm/views/__init__.py +++ b/bookwyrm/views/__init__.py @@ -4,6 +4,7 @@ from .author import Author, EditAuthor from .block import Block, unblock from .books import Book, EditBook, ConfirmEditBook, Editions from .books import upload_cover, add_description, switch_edition, resolve_book +from .directory import Directory from .error import not_found_page, server_error_page from .federation import Federation from .feed import DirectMessage, Feed, Replies, Status diff --git a/bookwyrm/views/directory.py b/bookwyrm/views/directory.py new file mode 100644 index 00000000..bbfbffe8 --- /dev/null +++ b/bookwyrm/views/directory.py @@ -0,0 +1,32 @@ +""" who all's here? """ +from django.contrib.auth.decorators import login_required +from django.core.paginator import Paginator +from django.template.response import TemplateResponse +from django.views import View +from django.utils.decorators import method_decorator + +from bookwyrm import models + +# pylint: disable=no-self-use +@method_decorator(login_required, name="dispatch") +class Directory(View): + """ display of known bookwyrm users """ + + def get(self, request): + """ lets see your cute faces """ + try: + page = int(request.GET.get("page", 1)) + except ValueError: + page = 1 + + users = models.User.objects.filter( + discoverable=True, + bookwyrm_user=True, + is_active=True, + ).order_by('-last_active_date') + paginated = Paginator(users, 12) + + data = { + "users": paginated.page(page), + } + return TemplateResponse(request, "directory.html", data) diff --git a/bookwyrm/views/landing.py b/bookwyrm/views/landing.py index 86f7d3e9..407451fb 100644 --- a/bookwyrm/views/landing.py +++ b/bookwyrm/views/landing.py @@ -2,7 +2,7 @@ from django.template.response import TemplateResponse from django.views import View -from bookwyrm import forms, models +from bookwyrm import forms from .feed import Feed from . import helpers From 6e3a203b466d24ef02518b1f6aa442801e308364 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sun, 21 Mar 2021 16:43:13 -0700 Subject: [PATCH 06/11] Adds directory to main menu --- bookwyrm/templates/layout.html | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/bookwyrm/templates/layout.html b/bookwyrm/templates/layout.html index b25bef45..e57f6152 100644 --- a/bookwyrm/templates/layout.html +++ b/bookwyrm/templates/layout.html @@ -83,18 +83,18 @@