From 69a24ad4544146941b737613a76b2db51537df24 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 09:46:17 +0000 Subject: [PATCH 01/17] Update default categories --- defaultcategories/en.xml | 272 +++++++++++++++++++-------------------- 1 file changed, 136 insertions(+), 136 deletions(-) diff --git a/defaultcategories/en.xml b/defaultcategories/en.xml index dd3715b1c..73b4ca9c3 100644 --- a/defaultcategories/en.xml +++ b/defaultcategories/en.xml @@ -6,499 +6,499 @@ sport billiard darts swim motorsport snooker marathon hockey diving baseball Millwall sailing athletics skating skiing sport football - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT + + + events + neverforget award OONIbday waybackwednesday notifications throwbackthursday adventskalender live Day deepthoughts thursdaythoughts humanrightsday followfriday wednesdaymotivation showerthoughts anarchymonday 100DaysToOffload ff holiday christmas week concert festival dontstarve onthisday livestream sunday screenshotsunday liverpool adayinthelife day InternationalCheetahDay interestingtimes meetup + + Tue, 22 Dec 2020 09:45:58 UT gafam - zuckerberg caringissharing apple antitrust GoogleDown bankruptBezos youtube ffs facebook interoperability amazon amazonring googleplus Facebook LeiharbeitAbschaffen advertising adtech fuckgoogle microsoft dtm twitter caffeine skype ff chrome hildebrandt youtubedl degoogled youtubers google sharingiscaring gis dt dotcoms deleteyoutube Instagram fascistbook FuckGoogle degoogle fuschia ungoogled ring affordances googledown gafam inspiring fuckoffgoogle deletefacebook office365 instagram MatrixEffect playstore bigtech + zuckerberg caringissharing apple antitrust GoogleDown bankruptBezos youtube ffs facebook interoperability amazon boycottinstagram amazonring googleplus degooglisation Facebook LeiharbeitAbschaffen advertising adtech fuckgoogle microsoft dtm twitter caffeine skype chrome hildebrandt youtubedl degoogled youtubers google sharingiscaring gis dt dotcoms deleteyoutube Instagram fascistbook FuckGoogle degoogle fuschia ungoogled ring affordances googledown gafam inspiring fuckoffgoogle deletefacebook office365 instagram MatrixEffect playstore bigtech - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT activitypub - followerpower Fediverse activitypub pleroma PeerTube webdev fediblock lazyfedi instances fedilab mastotips mastodev friendica misskey siskin followers fediart Pixelfed pixelfed fedidb block Fediseminar monal tusky peertubers imagedescription feditips fedizens Mastodon following epicyon mastomagic dev fediadmin pixeldev instanceblock isolategab fedireads PeertubeMastodonHost Bookwyrm socialhome fediverse smithereen mastodon fedi fediplay peertube lab mobilizon gemifedi + followerpower Fediverse activitypub pleroma PeerTube webdev fediblock lazyfedi federation instances fedilab mastotips mastodev friendica misskey siskin followers fediart Pixelfed pixelfed fediverseplaysjackbox fedidb block Fediseminar monal tusky peertubers imagedescription feditips fedizens Mastodon following epicyon mastomagic dev fediadmin pixeldev instanceblock mastodonmonday isolategab fedireads PeertubeMastodonHost Bookwyrm socialhome MastodonMondays fediverse smithereen mastodon fedi fediplay peertube lab mobilizon gemifedi - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT programming - Easer cpp report programming css Python FrancisBacon2020 mixers release ada schutzstreifen rustlang ocaml program matrix uptronics profiles typescript forums publiccode FreeSoftware rocketchat early adventofcode scripting warn discord spyware git trevornoah copyright daretocare fedidev c sourcecode publiekecode framaforms WendyLPatrick grep django kingparrot Leiharbeit programmer haskell Tarifvertrag frgmntscnr github openrc tuskydev algorithms lisp forge pleaseshare HirsuteHippo resnetting libraries drivers javascript fragment cpm code elisp TeamFerment patterns html terminal rust sauerkraut request spiritbomb r dramasystem clojurescript ruby peppertop contractpatch computers racket python kabelfernsehen OpenSource Scheibenwischer + Easer cpp report programming css tootfic objects Python FrancisBacon2020 mixers release ada schutzstreifen rustlang ocaml program request_reaction uptronics solidarity hypocritcal profiles typescript forums publiccode FreeSoftware vieprivée early adventofcode scripting warn spyware git trevornoah zinccoop daretocare fedidev c sourcecode publiekecode misc framaforms WendyLPatrick grep django gmic sackthelot relevance_P1Y kingparrot Leiharbeit programmer haskell Tarifvertrag frgmntscnr github openrc tuskydev threema algorithms lisp forge pleaseshare HirsuteHippo resnetting fourtwenty libraries drivers javascript fragment cpm code elisp patterns html terminal rust sauerkraut request spiritbomb r dramasystem documentary clojurescript ruby contractpatch computers racket relationships python kabelfernsehen alternatives OpenSource Scheibenwischer - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT writing - blog poem blogs interactivestorytelling WriteFreely goodreads journal poetry + blog authors poem smallstories blogs interactivestorytelling WriteFreely storytelling goodreads journal poetry - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT hardware - plugandplay PersonalComputer cyberdeck PineCUBE keyboards screenless modem analogcomputing TrueDelta keyboard cybredeck solarpunk lenovo fairelectronics ibm 3dprinting MechcanicalKeyboards openhardware raspberrypi barcode pinetime pinebookpro PinebookPro 3dprint arm paperComputer amd thinkpad print + plugandplay PersonalComputer cyberdeck PineCUBE keyboards screenless modem analogcomputing TrueDelta keyboard printmaker cybredeck laptop solarpunk recycling lenovo fairelectronics fuse ibm 3dprinting MechcanicalKeyboards openhardware raspberrypi barcode pinetime pinebookpro PinebookPro 3dprint arm paperComputer amd openpower thinkpad print - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT places - lapaz luanda asunción nouakchott conakry kyiv moscow saipan gibraltar dublin dannibleibt avarua hargeisa delhi niamey chișinău colombo brasília phnompenh mbabane belgrade belmopan pyongyang hannover ulaanbaatar oranjestad gaborone seattle ndjamena raw singapore kingedwardpoint abidjan nuuk pretoria papeete malé zagreb gitega abudhabi flyingfishcove castries georgetown hagåtña basseterre hamburg kinshasa suva valparaíso athens roseau baku charlotteamalie antananarivo domi pristina santiago sukhumi berlin uptronicsberlin funafuti libreville hanoi philipsburg tehran banjul prague andorralavella daw yerevan portauprince dakar paramaribo tifariti capetown tirana klima ankara ipswich managua lisbon bishkek amsterdam portonovo santodomingo bangkok bucharest kathmandu aden madrid sanjuan vienna kingston kabul damascus stockholm douglas willemstad thehague panamacity beirut amman newdelhi tórshavn nouméa oslo alofi gustavia paris video cockburntown ottawa stepanakert portofspain fsberlin honiara asmara florida nicosia helsinki taipei tegucigalpa tokyo tashkent MadeInEU sarajevo algiers nairobi muscat monaco riyadh lusaka wellington bissau juba mariehamn majuro buenosaires ngerulmud dhaka guatemalacity washington vatican kuwaitcity bern mexicocity bratislava bridgetown delhipolice tunis manila stanley matautu copenhagen barcelona lomé budapest ouagadougou mogadishu freetown victoria brazzaville portmoresby ashgabat kampala elaaiún vilnius bloemfontein sucre london marseille pagopago bradesestate oakland vaduz addis nürnberg naypyidaw CassetteNavigation khartoum baghdad bandar moroni portvila kingstown ChrisCrawford reykjavík manama accra windhoek nukualofa ciutatvella tbilisi canberra quito maputo cetinje putrajaya ramallah bogotá dodoma harare havana warsaw münster valletta localberlin ljubljana bamako kualalumpur podgorica rabat cotonou plymouth seoul Portland dushanbe bangui aotearoa westisland tskhinvali palikir caracas jamestown rome munich ass freestuffberlin sãotomé jakarta daressalaam sansalvador apia essex yaren cairo jerusalem brussels kigali southtarawa beijing minsk montevideo vientiane maseru hamilton doha tripoli portlouis lima adamstown abuja lilongwe nassau lobamba heathrow nyc montreal dili riga lesbos monrovia nursultan gab sanjosé marigot islamabad malabo tallinn sahara thimphu yaoundé praia bujumbura sofia skopje + lapaz luanda asunción nouakchott conakry kyiv moscow saipan gibraltar dublin dannibleibt avarua hargeisa delhi niamey chișinău colombo brasília phnompenh mbabane belgrade belmopan pyongyang hannover ulaanbaatar oranjestad gaborone seattle ndjamena raw singapore kingedwardpoint abidjan nuuk pretoria papeete malé zagreb gitega abudhabi flyingfishcove castries georgetown hagåtña borikua basseterre hamburg kinshasa suva valparaíso athens roseau baku charlotteamalie antananarivo domi pristina santiago sukhumi berlin uptronicsberlin funafuti libreville hanoi philipsburg tehran banjul prague andorralavella daw yerevan portauprince dakar paramaribo tifariti capetown tirana klima ankara ipswich managua lisbon bishkek amsterdam portonovo santodomingo bangkok bucharest kathmandu aden madrid sanjuan vienna kingston kabul damascus stockholm douglas willemstad thehague panamacity beirut amman newdelhi tórshavn nouméa oslo alofi gustavia paris video cockburntown ottawa stepanakert portofspain fsberlin honiara asmara florida nicosia helsinki taipei tegucigalpa tokyo tashkent larochelle MadeInEU sarajevo algiers nairobi muscat monaco riyadh lusaka wellington bissau juba mariehamn majuro buenosaires ngerulmud dhaka guatemalacity washington vatican kuwaitcity bern mexicocity bratislava bridgetown delhipolice tunis manila stanley matautu copenhagen barcelona lomé budapest ouagadougou mogadishu freetown victoria brazzaville portmoresby ashgabat kampala elaaiún vilnius bloemfontein sucre london marseille pagopago bradesestate oakland vaduz addis nürnberg naypyidaw CassetteNavigation khartoum baghdad bandar moroni lehavre portvila kingstown ChrisCrawford reykjavík manama accra windhoek nukualofa ciutatvella tbilisi canberra quito maputo cetinje putrajaya ramallah bogotá dodoma harare havana warsaw münster valletta localberlin ljubljana bamako kualalumpur podgorica rabat cotonou plymouth seoul Portland dushanbe bangui aotearoa westisland tskhinvali palikir caracas jamestown rome munich ass freestuffberlin sãotomé jakarta daressalaam sansalvador apia essex yaren cairo jerusalem brussels kigali southtarawa beijing minsk montevideo vientiane maseru hamilton doha tripoli celtic portlouis lima adamstown abuja lilongwe nassau lobamba heathrow nyc montreal dili riga lesbos monrovia nursultan gab sanjosé marigot islamabad malabo tallinn sahara thimphu yaoundé praia bujumbura sofia skopje - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT music - musicprodution punk ourbeats indiemusic streetpunk bandcamp musicians ipod skinheadmusic rap mp3 Music EnvoieStopHashtagAu81212 thecure vaporwave dubstep synthwave oi rave freemusic nowplaying hiphop experimentalmusic fedimusic soundcloud frankiegoestohollywood dj newwave dorkwave producing musicproduction NowPlaying libremusicproduction MusicAdvent coinkydink fedivers arianagrande synth music metal fediversemusic cyberpunkmusic BandcampFriday + musicprodution punk ourbeats indiemusic streetpunk bandcamp musicians jamendo ipod skinheadmusic rap mp3 Music EnvoieStopHashtagAu81212 thecure vaporwave dubstep synthwave oi rave freemusic nowplaying hiphop experimentalmusic fedimusic soundcloud frankiegoestohollywood dj newwave dorkwave producing musicproduction funkwhale NowPlaying libremusicproduction MusicAdvent coinkydink fedivers arianagrande synth music metal fediversemusic cyberpunkmusic BandcampFriday - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT politics - solidarity hypocritcal TakeOurPowerBack cia community wageslavery immigration dissent liberation fascism techtuesday skyofmywindow freedomofspeech rojava humanrights leftists Socialism ukpol FreeKeithLamar copwatch capitalismkills petition BorisJohnson freedom abolitionnow anarchism DefundThePolice technews smalltech oilwars bjp ThirdRunway election sky_of_my_window generalstrike antipolitics digitalfreedom mayday hatespeech fascists burntheprisons cyberlaw peerproduction corporations iww commons corporatewatch wageslave frontex communism RemoveThePolice neoliberalism socialecology MutualAid capitalism technology prisons conspiracytheories KeirStarmer politics inclusivity anarchisme nzpol Bookchin brexit totalitarianism TyskySour Labour green BAME decolonizeyourmind surfaceworldblows ecofascism SocietalChange facialrecognition propaganda decolonization digitalrights polizei xp 18Source redandanarchistskinheads PritiPatel latestagecapitalism racist elections RussellMaroonShoatz white prisoners warrants policebrutality borisjohnson Anarchist press mutuality whitehouse freedomofexpression censorship decolonize decenterwhiteness Biden ChineseAppBan cooperative modi law deathtoamerica manipulation britpol Capitalism surveillancecapitalism leftist Revolution ukpolitics blacklivesmatter FreeAlabamaMovement rentstrike dsa techno migration mutualaid multipleexposure AbolishPrison fascist socialcoop anarchistprisoners polizeiproblem wordpress uselection IDPol ourstreets refugees acab freewestpapua tech + TakeOurPowerBack cia community wageslavery immigration dissent liberation fascism techtuesday skyofmywindow freedomofspeech rojava humanrights leftists Socialism ukpol FreeKeithLamar copwatch capitalismkills petition BorisJohnson freedom abolitionnow anarchism DefundThePolice technews smalltech oilwars bjp ThirdRunway election sky_of_my_window generalstrike antipolitics digitalfreedom mayday hatespeech fascists lowtech burntheprisons cyberlaw peerproduction corporations iww commons corporatewatch wageslave frontex communism RemoveThePolice neoliberalism socialecology MutualAid capitalism technology prisons conspiracytheories KeirStarmer politics inclusivity anarchisme nzpol Bookchin ClemencyNow brexit totalitarianism TyskySour Labour green BAME decolonizeyourmind surfaceworldblows ecofascism SocietalChange facialrecognition anarchy propaganda decolonization digitalrights polizei xp 18Source redandanarchistskinheads PritiPatel latestagecapitalism racist elections RussellMaroonShoatz white prisoners warrants policebrutality borisjohnson Anarchist press mutuality whitehouse freedomofexpression censorship decolonize decenterwhiteness Biden ChineseAppBan cooperative modi law deathtoamerica manipulation britpol Capitalism surveillancecapitalism leftist Revolution ukpolitics blacklivesmatter FreeAlabamaMovement rentstrike dsa techno migration mutualaid multipleexposure AbolishPrison fascist socialcoop anarchistprisoners polizeiproblem uselection IDPol Slavetrade ourstreets refugees acab freewestpapua tech - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT food - vitamind cake margarine dessert salsa caviar theexpanse cookery pietons food skillet liquor milk bolognese recipe foodporn yeast plate waffle biscuit glaze omelette filet pastry wine hamburger juice Amazfish sourdough nuts gras toast broth batter foodie ketchup seasoning mayo soup pan voc teamcapy mayonnaise vegan dish avocado spice bakery cooking yogurt spotify crumble cider butter cook cobbler steak pizza soda aroma oil flour cream nutella pie cuisine tartar tea marinade mushroom entree bread salad beans fresh syrup fermentation mushrooms cookie curd soysauce pudding beer baking fish foodwaste wheat pot stew chocolate paste wok recipes olive burger candy kitchen coffee bagel taste meat noodle raclette caramel rice eggs grill poutine lard croissant pasta foods cheese oregano drink muffin foie sauce soy cocoa sandwich mousse chili vinegar + vitamind cake margarine dessert salsa caviar theexpanse cookery pietons food skillet liquor milk bolognese recipe foodporn yeast plate waffle biscuit glaze omelette filet pastry wine hamburger juice Amazfish sourdough nuts gras toast broth batter foodie ketchup seasoning mayo soup pan voc teamcapy mayonnaise vegan dish avocado spice bakery cooking yogurt spotify crumble cider butter cook pottery cobbler steak pizza soda fedikitchen aroma oil flour cream nutella pie cuisine tartar tea marinade mushroom entree bread salad beans fresh syrup fermentation mushrooms cookie curd soysauce pudding beer baking fish foodwaste wheat pot TeamFerment stew chocolate paste wok recipes olive burger candy kitchen coffee bagel taste meat noodle raclette caramel rice eggs grill poutine lard croissant pasta foods cheese oregano drink muffin foie sauce soy vore cocoa sandwich mousse chili vinegar - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT farming johndeere - Sun, 20 Dec 2020 20:57:26 UT - - - events - award OONIbday waybackwednesday notifications throwbackthursday adventskalender live Day deepthoughts thursdaythoughts humanrightsday followfriday wednesdaymotivation showerthoughts anarchymonday 100DaysToOffload holiday Introduction christmas week anarchy concert festival dontstarve onthisday livestream sunday screenshotsunday adayinthelife day InternationalCheetahDay interestingtimes meetup - - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT countries - romania burma lithuania solomon chile Instanz opensuse fiji tajikistan benin paraguay eeuu senegal ukraine italy brunei nicaragua guyana Pflanzenbestimmung euphoria zambia iceland morocco netherlands swaziland bosnian suriname elsalvador russia samoa european czech belarus hayabusa2 kyrgyzstan uk abuse translation sanmarino catalonia panama japan venezuela gambia freeNukem kuwait barbados papua greece switzerland uae nigeria usa angola honduras djibouti laos sierraleone cambodia ych vietnam dust3d neofeud seychelles marshall kazakhstan estonia tonga stlucia burundi bangladesh egypt mali congo us jordan speedrun grenada israel algeria ghana bosnia russian industrial eritrea bhutan hungary saudi slovenia tig bahamas australia kiribati togo koreanorth poland malawi capeverde run armenia american hautrauswasgeht bahrain mozambique beleuchtung southsudan syria micronesia maldives iran sweden ethiopia cuba liberia canada burkina somalia Chile scotland vaticancity easttimor austria turkey yemen Bolivia denmark trunk madagascar finland philippines ivorycoast haiti ecuador Portugal azerbaijan gasuk spain albania afghanistan europe mauritania dominica thailand belize westpapuauprising macedonia illustration montenegro qatar mongolia costarica boatingeurope birdsofkenya latvia uzbekistan ireland iraq malaysia mexico mauritius oman chad nz georgia zimbabwe france serbia lesotho oddmuse tunisia argentina cameroon namibia sudan indonesia colombia tuvalu beckychambers turkmenistan tanzania germany neuhier norway comoros auteursrecht guatemala kosovo andorra wales servus pakistan belgium china antigua life koreasouth newzealand einzelfall rwanda luxembourg libya italyisntreal nauru Anarchismus moldova palau taiwan kenya trinidad eu botswana CuriosidadesVariadas jamaica vanuatu cyprus aminus3 malta niger westpapua busse unitedstates myanmar saintvincent guinea nepal peru uganda uruguay india lebanon neurodiversity southafrica croatia europeanunion bolivia chinese dominican srilanka bulgaria slovakia speedrunning gabon stkitts liechtenstein brazil shutdowncanada + romania burma lithuania solomon chile Instanz opensuse fiji tajikistan benin paraguay eeuu senegal ukraine italy brunei nicaragua guyana Pflanzenbestimmung euphoria zambia iceland morocco netherlands swaziland bosnian solo suriname elsalvador russia samoa european czech belarus hayabusa2 kyrgyzstan uk abuse translation sanmarino catalonia panama japan buyused venezuela gambia freeNukem kuwait barbados papua greece switzerland uae nigeria usa angola honduras djibouti laos sierraleone cambodia ych vietnam dust3d neofeud seychelles marshall kazakhstan estonia tonga stlucia burundi bangladesh egypt mali congo us jordan speedrun grenada israel algeria ghana bosnia russian industrial eritrea bhutan hungary saudi slovenia uspol tig bahamas australia kiribati togo koreanorth poland malawi capeverde run armenia american hautrauswasgeht bahrain mozambique beleuchtung southsudan syria micronesia maldives iran indigenous sweden ethiopia cuba liberia canada burkina somalia Chile scotland vaticancity easttimor austria turkey yemen Bolivia denmark trunk madagascar finland philippines ivorycoast haiti ecuador Portugal azerbaijan gasuk spain albania afghanistan europe mauritania dominica thailand belize westpapuauprising macedonia illustration montenegro qatar mongolia costarica boatingeurope birdsofkenya latvia uzbekistan ireland iraq malaysia mexico mauritius oman chad nz georgia zimbabwe france serbia lesotho oddmuse tunisia argentina cameroon namibia sudan indonesia colombia tuvalu beckychambers turkmenistan tanzania germany neuhier norway comoros auteursrecht guatemala kosovo andorra wales servus pakistan belgium china antigua life koreasouth newzealand einzelfall rwanda luxembourg libya italyisntreal nauru Anarchismus moldova palau taiwan kenya trinidad eu botswana CuriosidadesVariadas jamaica vanuatu cyprus aminus3 malta niger westpapua busse unitedstates myanmar saintvincent guinea nepal peru uganda uruguay india lebanon neurodiversity southafrica croatia europeanunion bolivia chinese dominican srilanka bulgaria slovakia speedrunning gabon stkitts liechtenstein brazil shutdowncanada - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT cycling bicycle cycling bike Snowbike - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT phones mobileapp pine fdroid plasmamobile android smartphone iOS14 BriarProject pinephone mobile fairphone ubuntutouch Android ubports osmand vodafone iphones postmarketos iOS microg mobileKüfA - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT science - math womeninstem supercollider dawkins graphTheory psychology biology gene paleontology + math womeninstem supercollider nextgeneration archaeologist dawkins graphTheory psychology biology gene paleontology - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT pandemic - covid19 corona Coronavirus CoronaWarnApp facemasks vaccines vaccine pandemic contacttracing covid coronavirus Lockdown codid19 COVID19 YesWeWork ContactTracing COVID + covid19 corona Coronavirus CoronaWarnApp facemasks vaccines vaccine pandemic contacttracing covid coronavirus virus Lockdown codid19 COVID19 YesWeWork ContactTracing COVID - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT software - app freedombox windows libre nginx Framasoft invidious drm publicdomain kubernetes fossmendations jami FuckOffZoom quicksy free docker freesoftware gimp foss nextcloud wechat openscad TabOrder ikiwiki Linux outreachy lyft nitter opensource diaspora yunohost littlebigdetails cabal conferencing accessibility devops owncast emacs freiesoftware email chatapps floss plugins deltachat application uifail FOSS bittorrent zoom gpl FriendofGNOME usability obnam snap cryptpad software OwnStream zrythm mumble grsync containers irssi mutt design gameoftrees backup rotonde GNU apps licensing profanity ffmpeg lemmy OSM win10 jitsi ux rsync libreoffice dino plugin OCUPACAOCARLOSMARIGHELLA whatsapp openoffice + app freedombox windows libre nginx Framasoft invidious drm publicdomain kubernetes fossmendations jami FuckOffZoom quicksy free docker freesoftware gimp foss matrix nextcloud wechat openscad TabOrder ikiwiki Linux rocketchat outreachy lyft nitter discord opensource diaspora yunohost littlebigdetails cabal conferencing accessibility devops owncast emacs freiesoftware email chatapps floss plugins deltachat application uifail FOSS bittorrent zoom gpl FriendofGNOME usability obnam snap cryptpad software OwnStream zrythm mumble grsync containers irssi mutt design gameoftrees backup rotonde GNU thunderbird apps licensing profanity ffmpeg lemmy OSM win10 jitsi wordpress ux rsync libreoffice dino plugin OCUPACAOCARLOSMARIGHELLA whatsapp openoffice - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT security encrypt password history cryptography solarwinds infosec gchq IHaveSomethingToHide IronySec cryptowars supplychainattacks UseAMaskUseTor cyberattack security tor e2e bruceschneier vpn openssh openssl e2ee ed25519 encryption ssh crypto giftofencryption malware opsec keepass torsocks nsa protonvpn yubikey nitrokey openpgp castor9 gpgtools gpg cybersecurity CryptoWars signal noscript np trust openvpn datasecurity tracking cloudflare - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT gardening - sporespondence blockade inde federation deno cabbage bundeswehr onions datenschleuder florespondence thyme DailyFlowers permaculture papuamerdeka flowers gardening de federated fahrräder golden genderQuiz + sporespondence blockade inde independant deno cabbage bundeswehr onions bordeaux datenschleuder florespondence thyme DailyFlowers permaculture papuamerdeka flowers gardening de federated devilslettuce fahrräder golden - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT conferences debconf talk fossdem FreedomBoxSummit schmoocon summit confidenceTricks minidebconf emacsconf ox defcon flossevent conf rC3 conference flossconf apconf C3 config - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT cats - Cat dailycatpic DailyCatVid Leopard + Cat dailycatpic dxp DailyCatVid CatsOfMastodon Leopard catbellies - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT employment InterviewQuestions reproductivework bullshitjobs antiwork worklog hire hirefedi work letthenetwork jobs - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT linux - osdev linuxisnotanos elementaryos cli kde Debian11 slackware mobian openwrt distros DebianBullseye shareyourdesktop wireguard linuxaudio gtk debian trisquel gnome linuxposting showyourdesktop ubuntu xubuntu unix fedora centos gentoo usergroup systemd linuxgaming Debian distro destinationlinux qubesos i3wm haiku linuxisnotaplatform linux netbsd termux btrfs reproduciblebuilds artix archlinux rhel debianinstaller linuxisajoke + osdev linuxisnotanos elementaryos cli kde Debian11 slackware mobian openwrt distros DebianBullseye shareyourdesktop wireguard linuxaudio gtk debian trisquel gnome linuxposting showyourdesktop ubuntu xubuntu unix fedora centos gentoo usergroup systemd linuxgaming Debian distro destinationlinux qubesos i3wm haiku linuxisnotaplatform linux netbsd termux btrfs reproduciblebuilds artix gtk4 archlinux rhel debianinstaller linuxisajoke - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT photos nikon photography photo tokyocameraclub photos photoshop camera picture streetphotography - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT + + + crafts + topic_imadethis upholstery hackerspaces sanding sundiy knitting hack biohacking wip jewelry diy upcycling woodworking origami makers quilting quilt 3dmodel woodwork ceramics + + Tue, 22 Dec 2020 09:45:58 UT pets catpics catalunya catofmastodon mastodogs catbehaviour dogsofmastodon gentrification cats kittens pet dog caturday catsofmastodon cute dogs mastocats cat catcontent - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT news - news newsletter doubledownnews journalism SkyNews + news Wikileaks newsletter doubledownnews journalism SkyNews - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT games minecraft tetris99 TerraNil boardgames gamedesign chess nintendoswitch mud game 0ad ttrpg gamedev guildwars2 TetrisGore gaming Gamesphere rpg tetris dosgaming DnD cyber2077 cyberpunk2077 FreeNukum neopets minetest guildwars dnd - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT retro A500 atarist commodore teletext floppy 8bit atari trs80 floppydisk retrocomputing C64 plan9 80s microcomputing omm retrogaming z80 8bitdo retro amiga bbcmicro microcomputer bbsing - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT indymedia - visionontv indymediaback pga indymedia omn tv 4opens + visionontv indymediaback pga indymedia omn tv 4opens openmedianetwork - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT activism - protestor g20 riseup sflc DanniVive reuse fsfe softwarefreedom ann activist xr directaction eff openrightsgroup protest actiondirecte kroymann HS2 ngo MarcWittmann fsf StopHS2 grassroots BLM changeisinyourhands conservancy XR freeolabini announcement isolateByoblu annieleonard + protestor grassroot g20 riseup sflc DanniVive reuse fsfe softwarefreedom ann activist xr directaction eff openrightsgroup protest actiondirecte kroymann HS2 ngo MarcWittmann fsf StopHS2 grassroots BLM changeisinyourhands conservancy JefferySaunders XR freeolabini announcement isolateByoblu annieleonard - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT questions askmastodon askfedi question askmasto askfediverse ask askfosstodon - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT internet - spam firefox redecentralize wikipedia rtmp decentralization decentralize w3c torrent data sitejs internetarchaeology WordPress self router dataretention selfhosting icann discourse PeerToPeer dns openstandards nojs oauth CDNsAreEvil protonmail standards yourdataisyourdata gemini SmallWeb xmpp semanticweb socialnetwork ntp socialnetworks proton icmp videocast jabber decentralized wiki ssb darknet cookies darkweb netcat server browser cloudy p2p social www ilovewikipedia web WebsiteStatus twitch socialmedia domain rss ipns mozilla voicemail mail ipfs browsers decentralizeit openculture cyberspace offthegrid cloud internet decentralisation internetarchive js dark openweb onlineharms dot internetshutdowns fixtheweb socialweb + spam firefox redecentralize wikipedia rtmp decentralization decentralize w3c torrent data sitejs internetarchaeology WordPress self router dataretention selfhosting icann discourse PeerToPeer dns openstandards nojs oauth CDNsAreEvil protonmail standards yourdataisyourdata gemini SmallWeb xmpp semanticweb socialnetwork ntp socialnetworks proton icmp videocast jabber decentralized wiki ssb darknet cookies darkweb netcat server browser cloudy p2p social www ilovewikipedia web WebsiteStatus twitch socialmedia domain rss ipns mozilla voicemail mail ipfs browsers decentralizeit openculture cyberspace offthegrid cloud internet decentralisation internetarchive js dark openweb onlineharms dot ftp internetshutdowns fixtheweb socialweb - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT birds - RainbowBeeEater bird thunderbird + RainbowBeeEater bird - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT ethics digitalethics ethics ethicallicense ethical - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT economics theWorkshop WealthConcentration funding shop startups HenryGeorge crowdfunding micropatronage monetize smallbusiness GitPay - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT podcasts podcasting IntergalacticWasabiHour podcast tilde til tilderadio podcasts smallisbeautiful tilvids - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT years Year2020 year 1yrago 5yrsago - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT identity boomer - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT political copservation linguisticProgramming - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT fashion brasil fashionistas fashionesta bras fashion patches - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT art - urban artvsartist2020 watercolor autisticartist barrigòtic art krita urbanart queerart deviantart adultcolouring collage streetart coverart MastoArt painting digitalart comic artwork mandala xkcd santa mastoart gnuimagemanipulationprogram webcomic furryart sticker TattoosOfTheFediverse artvsartist artist meme concretepoetry artwithopensource blackartist zine JuliaHartleyBrewer + urban glassart artvsartist2020 watercolor autisticartist barrigòtic art krita urbanart queerart deviantart adultcolouring collage streetart coverart MastoArt culture polArt ink painting digitalart comic artwork mandala xkcd comics santa mastoart gnuimagemanipulationprogram wireart cartoon webcomic furryart sticker artbreeder arttherapy TattoosOfTheFediverse artvsartist sculpture artist meme concretepoetry artwithopensource peppertop blackartist zine furry JuliaHartleyBrewer - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT month april july march october november august june december september may feburary january month - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT funding disabledcrowdfund patreon - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT + + + books + justhollythings earthsea ebooks book amreading bookreview theLibrary wayfarers books ebook epub cookbook + + Tue, 22 Dec 2020 09:45:58 UT comedy laugh humour satire irony standup funny humor - Sun, 20 Dec 2020 20:57:26 UT - - - crafts - upholstery hackerspaces sanding sundiy knitting hack biohacking wip jewelry diy upcycling woodworking origami makers quilting quilt 3dmodel woodwork - - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT health - medical burnout medicine treatment EmotionalFirstAid autistic health meds + medical burnout cannabis medicine treatment EmotionalFirstAid maryjane autistic health meds marijuana - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT seasons - spring autumn winter summer + spring autumn winter summer solstice wintersolstice - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT gender - transwomen transcrowdfund female trans women estradiol queer woman transrights + transwomen transcrowdfund female trans women estradiol queer genderQuiz woman transrights - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT fiction - cyberpunk thehobbit fiction + cyberpunk thehobbit fiction microfiction - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT legal hfgkarlsruhe amro GameSphere OnlineHarmsBill laipower gdpr intros Anticritique learning energyflow digitalservicesact geekproblem - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT introductions - newhere introductions + newhere firsttoot Introduction Introductions introduction introductions - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT audio audioproduction audiofeedback audio - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT bots bot - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT climate - clouds renewableenergy amp climateemergency climate coal globalwarming weather climatecamp sky climatescience climatecrisis + clouds renewableenergy amp climateemergency climate coal globalwarming weather climatecamp science sky climatescience climatecrisis - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT nature morning trees light birds nature frogs sunrise inaturalist morningcrew australianwildlife capybara amphibians - Sun, 20 Dec 2020 20:57:26 UT - - - books - earthsea ebooks book amreading bookreview theLibrary wayfarers books ebook epub cookbook - - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT scifi startrek starwars babylon5 - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT religion - pagan + neopagan pagan - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT media - mainstreaming weAreAllCrazy theatlantic traditionalmedia videos railroads ai realmedia + mainstreaming stream streaming weAreAllCrazy maiabeyrouti theatlantic traditionalmedia videos railroads taina ai realmedia media - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT techbros hackernews red reddit - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT photography landscapephotography - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT moderation fedblock - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT languages lojban - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT election voted vote - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT #music trance - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT + + + facts + didyouknow + + Tue, 22 Dec 2020 09:45:58 UT radio - radiohost vantascape vantaradio ca radio healthcare hamradio FreeAllPoliticalPrisoners radiobroadcasting 3dcad radioshow california listeningtonow radiobroadcast spazradio anonradio dmca + radiohost vantascape vantaradio ca radio healthcare hamradio FreeAllPoliticalPrisoners card10 radiobroadcasting 3dcad radioshow local california listeningtonow radiobroadcast spazradio anonradio dmca - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT licenses - creative creativecommons + copyright creative creativecommons - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT education education teach tutorial - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT microcontroller microcontroller arduino - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT scotland glasgow highlands edinburgh loch - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT astronomy space jupiter moon saturn milkyway - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT entertainment - watching Thundercat entertainment themandalorian + watching Thundercat thisisthetypeofmemethatilikecauseitcontainsreptiles entertainment me meow themandalorian - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT privacy privacymatters surveillance dataprivacy privacy - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT environment climatechange climatechaos - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT #software flatpak - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT microcontrollers esp8266 esp32 - Sun, 20 Dec 2020 20:57:26 UT - - - people - introduction - - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT help helpful help - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT war weapons - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT philosophy stoic postmodernism - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT france Macronavirus - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT travel travel taxi - Sun, 20 Dec 2020 20:57:26 UT + Tue, 22 Dec 2020 09:45:58 UT From 679c06b20ea4ef1b6d5fc13f566231462ccbf103 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 10:13:15 +0000 Subject: [PATCH 02/17] Don't guess very small tags --- inbox.py | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/inbox.py b/inbox.py index 71c090a7b..bf6386b9a 100644 --- a/inbox.py +++ b/inbox.py @@ -81,14 +81,20 @@ def guessHashtagCategory(tagName: str, hashtagCategories: {}) -> str: for categoryStr, hashtagList in hashtagCategories.items(): for hashtag in hashtagList: - if hashtag in tagName or tagName in hashtag: - if not categoryMatched: - tagMatchedLen = len(hashtag) + if len(hashtag) < 3: + # avoid matching very small strings which often + # lead to spurious categories + continue + if hashtag not in tagName: + if tagName not in hashtag: + continue + if not categoryMatched: + tagMatchedLen = len(hashtag) + categoryMatched = categoryStr + else: + # match the longest tag + if len(hashtag) > tagMatchedLen: categoryMatched = categoryStr - else: - # match the longest tag - if len(hashtag) > tagMatchedLen: - categoryMatched = categoryStr if not categoryMatched: return return categoryMatched From 96e813181b07d3aae2779d6a051d34d37e8009a4 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 10:30:52 +0000 Subject: [PATCH 03/17] Move hashtag categories functions to their own module --- categories.py | 184 +++++++++++++++++++++++++++++++++++++++++ daemon.py | 2 +- inbox.py | 33 +------- newswire.py | 2 +- utils.py | 146 -------------------------------- webapp_hashtagswarm.py | 4 +- webapp_search.py | 2 +- 7 files changed, 192 insertions(+), 181 deletions(-) create mode 100644 categories.py diff --git a/categories.py b/categories.py new file mode 100644 index 000000000..5b1445d9d --- /dev/null +++ b/categories.py @@ -0,0 +1,184 @@ +__filename__ = "categories.py" +__author__ = "Bob Mottram" +__license__ = "AGPL3+" +__version__ = "1.1.0" +__maintainer__ = "Bob Mottram" +__email__ = "bob@freedombone.net" +__status__ = "Production" + +import os +import datetime + + +def getHashtagCategory(baseDir: str, hashtag: str) -> str: + """Returns the category for the hashtag + """ + categoryFilename = baseDir + '/tags/' + hashtag + '.category' + if not os.path.isfile(categoryFilename): + categoryFilename = baseDir + '/tags/' + hashtag.title() + '.category' + if not os.path.isfile(categoryFilename): + categoryFilename = \ + baseDir + '/tags/' + hashtag.upper() + '.category' + if not os.path.isfile(categoryFilename): + return '' + + with open(categoryFilename, 'r') as fp: + categoryStr = fp.read() + if categoryStr: + return categoryStr + return '' + + +def getHashtagCategories(baseDir: str, recent=False, category=None) -> None: + """Returns a dictionary containing hashtag categories + """ + hashtagCategories = {} + + if recent: + currTime = datetime.datetime.utcnow() + daysSinceEpoch = (currTime - datetime.datetime(1970, 1, 1)).days + recently = daysSinceEpoch - 1 + + for subdir, dirs, files in os.walk(baseDir + '/tags'): + for f in files: + if not f.endswith('.category'): + continue + categoryFilename = os.path.join(baseDir + '/tags', f) + if not os.path.isfile(categoryFilename): + continue + hashtag = f.split('.')[0] + with open(categoryFilename, 'r') as fp: + categoryStr = fp.read() + + if not categoryStr: + continue + + if category: + # only return a dictionary for a specific category + if categoryStr != category: + continue + + if recent: + tagsFilename = baseDir + '/tags/' + hashtag + '.txt' + if not os.path.isfile(tagsFilename): + continue + modTimesinceEpoc = \ + os.path.getmtime(tagsFilename) + lastModifiedDate = \ + datetime.datetime.fromtimestamp(modTimesinceEpoc) + fileDaysSinceEpoch = \ + (lastModifiedDate - + datetime.datetime(1970, 1, 1)).days + if fileDaysSinceEpoch < recently: + continue + + if not hashtagCategories.get(categoryStr): + hashtagCategories[categoryStr] = [hashtag] + else: + if hashtag not in hashtagCategories[categoryStr]: + hashtagCategories[categoryStr].append(hashtag) + break + return hashtagCategories + + +def _updateHashtagCategories(baseDir: str) -> None: + """Regenerates the list of hashtag categories + """ + categoryListFilename = baseDir + '/accounts/categoryList.txt' + hashtagCategories = getHashtagCategories(baseDir) + if not hashtagCategories: + if os.path.isfile(categoryListFilename): + os.remove(categoryListFilename) + return + + categoryList = [] + for categoryStr, hashtagList in hashtagCategories.items(): + categoryList.append(categoryStr) + categoryList.sort() + + categoryListStr = '' + for categoryStr in categoryList: + categoryListStr += categoryStr + '\n' + + # save a list of available categories for quick lookup + with open(categoryListFilename, 'w+') as fp: + fp.write(categoryListStr) + + +def _validHashtagCategory(category: str) -> bool: + """Returns true if the category name is valid + """ + if not category: + return False + + invalidChars = (',', ' ', '<', ';', '\\') + for ch in invalidChars: + if ch in category: + return False + + # too long + if len(category) > 40: + return False + + return True + + +def setHashtagCategory(baseDir: str, hashtag: str, category: str, + force=False) -> bool: + """Sets the category for the hashtag + """ + if not _validHashtagCategory(category): + return False + + if not force: + hashtagFilename = baseDir + '/tags/' + hashtag + '.txt' + if not os.path.isfile(hashtagFilename): + hashtag = hashtag.title() + hashtagFilename = baseDir + '/tags/' + hashtag + '.txt' + if not os.path.isfile(hashtagFilename): + hashtag = hashtag.upper() + hashtagFilename = baseDir + '/tags/' + hashtag + '.txt' + if not os.path.isfile(hashtagFilename): + return False + + if not os.path.isdir(baseDir + '/tags'): + os.mkdir(baseDir + '/tags') + categoryFilename = baseDir + '/tags/' + hashtag + '.category' + if force: + # don't overwrite any existing categories + if os.path.isfile(categoryFilename): + return False + with open(categoryFilename, 'w+') as fp: + fp.write(category) + _updateHashtagCategories(baseDir) + return True + + return False + + +def guessHashtagCategory(tagName: str, hashtagCategories: {}) -> str: + """Tries to guess a category for the given hashtag. + This works by trying to find the longest similar hashtag + """ + categoryMatched = '' + tagMatchedLen = 0 + + for categoryStr, hashtagList in hashtagCategories.items(): + for hashtag in hashtagList: + if len(hashtag) < 3: + # avoid matching very small strings which often + # lead to spurious categories + continue + if hashtag not in tagName: + if tagName not in hashtag: + continue + if not categoryMatched: + tagMatchedLen = len(hashtag) + categoryMatched = categoryStr + else: + # match the longest tag + if len(hashtag) > tagMatchedLen: + categoryMatched = categoryStr + if not categoryMatched: + return + return categoryMatched diff --git a/daemon.py b/daemon.py index 7d661b16f..8404c359e 100644 --- a/daemon.py +++ b/daemon.py @@ -174,7 +174,7 @@ from shares import removeShare from shares import expireShares from utils import getFullDomain from utils import removeHtml -from utils import setHashtagCategory +from categories import setHashtagCategory from utils import isEditor from utils import getImageExtensions from utils import mediaFileMimeType diff --git a/inbox.py b/inbox.py index bf6386b9a..653e539af 100644 --- a/inbox.py +++ b/inbox.py @@ -32,8 +32,8 @@ from utils import loadJson from utils import saveJson from utils import updateLikesCollection from utils import undoLikesCollectionEntry -from utils import getHashtagCategories -from utils import setHashtagCategory +from categories import getHashtagCategories +from categories import setHashtagCategory from httpsig import verifyPostHeaders from session import createSession from session import getJson @@ -70,34 +70,7 @@ from content import dangerousMarkup from happening import saveEventPost from delete import removeOldHashtags from follow import isFollowingActor - - -def guessHashtagCategory(tagName: str, hashtagCategories: {}) -> str: - """Tries to guess a category for the given hashtag. - This works by trying to find the longest similar hashtag - """ - categoryMatched = '' - tagMatchedLen = 0 - - for categoryStr, hashtagList in hashtagCategories.items(): - for hashtag in hashtagList: - if len(hashtag) < 3: - # avoid matching very small strings which often - # lead to spurious categories - continue - if hashtag not in tagName: - if tagName not in hashtag: - continue - if not categoryMatched: - tagMatchedLen = len(hashtag) - categoryMatched = categoryStr - else: - # match the longest tag - if len(hashtag) > tagMatchedLen: - categoryMatched = categoryStr - if not categoryMatched: - return - return categoryMatched +from categories import guessHashtagCategory def storeHashTags(baseDir: str, nickname: str, postJsonObject: {}) -> None: diff --git a/newswire.py b/newswire.py index 8e4e41f1c..452cd076b 100644 --- a/newswire.py +++ b/newswire.py @@ -15,7 +15,7 @@ from datetime import timedelta from datetime import timezone from collections import OrderedDict from utils import validPostDate -from utils import setHashtagCategory +from categories import setHashtagCategory from utils import firstParagraphFromString from utils import isPublicPost from utils import locatePost diff --git a/utils.py b/utils.py index f667e1088..2ed990cc1 100644 --- a/utils.py +++ b/utils.py @@ -78,152 +78,6 @@ def isDormant(baseDir: str, nickname: str, domain: str, actor: str, return False -def getHashtagCategory(baseDir: str, hashtag: str) -> str: - """Returns the category for the hashtag - """ - categoryFilename = baseDir + '/tags/' + hashtag + '.category' - if not os.path.isfile(categoryFilename): - categoryFilename = baseDir + '/tags/' + hashtag.title() + '.category' - if not os.path.isfile(categoryFilename): - categoryFilename = \ - baseDir + '/tags/' + hashtag.upper() + '.category' - if not os.path.isfile(categoryFilename): - return '' - - with open(categoryFilename, 'r') as fp: - categoryStr = fp.read() - if categoryStr: - return categoryStr - return '' - - -def getHashtagCategories(baseDir: str, recent=False, category=None) -> None: - """Returns a dictionary containing hashtag categories - """ - hashtagCategories = {} - - if recent: - currTime = datetime.datetime.utcnow() - daysSinceEpoch = (currTime - datetime.datetime(1970, 1, 1)).days - recently = daysSinceEpoch - 1 - - for subdir, dirs, files in os.walk(baseDir + '/tags'): - for f in files: - if not f.endswith('.category'): - continue - categoryFilename = os.path.join(baseDir + '/tags', f) - if not os.path.isfile(categoryFilename): - continue - hashtag = f.split('.')[0] - with open(categoryFilename, 'r') as fp: - categoryStr = fp.read() - - if not categoryStr: - continue - - if category: - # only return a dictionary for a specific category - if categoryStr != category: - continue - - if recent: - tagsFilename = baseDir + '/tags/' + hashtag + '.txt' - if not os.path.isfile(tagsFilename): - continue - modTimesinceEpoc = \ - os.path.getmtime(tagsFilename) - lastModifiedDate = \ - datetime.datetime.fromtimestamp(modTimesinceEpoc) - fileDaysSinceEpoch = \ - (lastModifiedDate - - datetime.datetime(1970, 1, 1)).days - if fileDaysSinceEpoch < recently: - continue - - if not hashtagCategories.get(categoryStr): - hashtagCategories[categoryStr] = [hashtag] - else: - if hashtag not in hashtagCategories[categoryStr]: - hashtagCategories[categoryStr].append(hashtag) - break - return hashtagCategories - - -def updateHashtagCategories(baseDir: str) -> None: - """Regenerates the list of hashtag categories - """ - categoryListFilename = baseDir + '/accounts/categoryList.txt' - hashtagCategories = getHashtagCategories(baseDir) - if not hashtagCategories: - if os.path.isfile(categoryListFilename): - os.remove(categoryListFilename) - return - - categoryList = [] - for categoryStr, hashtagList in hashtagCategories.items(): - categoryList.append(categoryStr) - categoryList.sort() - - categoryListStr = '' - for categoryStr in categoryList: - categoryListStr += categoryStr + '\n' - - # save a list of available categories for quick lookup - with open(categoryListFilename, 'w+') as fp: - fp.write(categoryListStr) - - -def validHashtagCategory(category: str) -> bool: - """Returns true if the category name is valid - """ - if not category: - return False - - invalidChars = (',', ' ', '<', ';', '\\') - for ch in invalidChars: - if ch in category: - return False - - # too long - if len(category) > 40: - return False - - return True - - -def setHashtagCategory(baseDir: str, hashtag: str, category: str, - force=False) -> bool: - """Sets the category for the hashtag - """ - if not validHashtagCategory(category): - return False - - if not force: - hashtagFilename = baseDir + '/tags/' + hashtag + '.txt' - if not os.path.isfile(hashtagFilename): - hashtag = hashtag.title() - hashtagFilename = baseDir + '/tags/' + hashtag + '.txt' - if not os.path.isfile(hashtagFilename): - hashtag = hashtag.upper() - hashtagFilename = baseDir + '/tags/' + hashtag + '.txt' - if not os.path.isfile(hashtagFilename): - return False - - if not os.path.isdir(baseDir + '/tags'): - os.mkdir(baseDir + '/tags') - categoryFilename = baseDir + '/tags/' + hashtag + '.category' - if force: - # don't overwrite any existing categories - if os.path.isfile(categoryFilename): - return False - with open(categoryFilename, 'w+') as fp: - fp.write(category) - updateHashtagCategories(baseDir) - return True - - return False - - def isEditor(baseDir: str, nickname: str) -> bool: """Returns true if the given nickname is an editor """ diff --git a/webapp_hashtagswarm.py b/webapp_hashtagswarm.py index 2a2cb52ac..61dd46b00 100644 --- a/webapp_hashtagswarm.py +++ b/webapp_hashtagswarm.py @@ -10,8 +10,8 @@ import os from shutil import copyfile from datetime import datetime from utils import getNicknameFromActor -from utils import getHashtagCategories -from utils import getHashtagCategory +from categories import getHashtagCategories +from categories import getHashtagCategory from webapp_utils import getSearchBannerFile from webapp_utils import getContentWarningButton from webapp_utils import htmlHeaderWithExternalStyle diff --git a/webapp_search.py b/webapp_search.py index 4fd3985ad..eab07e191 100644 --- a/webapp_search.py +++ b/webapp_search.py @@ -19,7 +19,7 @@ from utils import locatePost from utils import isPublicPost from utils import firstParagraphFromString from utils import searchBoxPosts -from utils import getHashtagCategory +from categories import getHashtagCategory from feeds import rss2TagHeader from feeds import rss2TagFooter from webapp_utils import getAltPath From a7b094f84f3b2d5917a8b7c24fde9a19bcfa6a93 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 12:59:46 +0000 Subject: [PATCH 04/17] Test for stranded functions which aren't called --- announce.py | 129 ------------------------------ blog.py | 19 ----- blurhash.py | 105 ------------------------- bookmarks.py | 204 ------------------------------------------------ content.py | 28 ------- daemon.py | 17 ---- delete.py | 111 -------------------------- inbox.py | 9 --- like.py | 70 ----------------- media.py | 5 +- person.py | 42 ---------- posts.py | 93 ---------------------- skills.py | 11 --- tests.py | 94 ++++++++++++++++++++++ theme.py | 33 -------- webapp_utils.py | 10 --- 16 files changed, 97 insertions(+), 883 deletions(-) diff --git a/announce.py b/announce.py index 45be9351b..5364ba483 100644 --- a/announce.py +++ b/announce.py @@ -183,135 +183,6 @@ def announcePublic(session, baseDir: str, federationList: [], debug, projectVersion) -def repeatPost(session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, httpPrefix: str, - announceNickname: str, announceDomain: str, - announcePort: int, announceHttpsPrefix: str, - announceStatusNumber: int, clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool, projectVersion: str) -> {}: - """Repeats a given status post - """ - announcedDomain = getFullDomain(announceDomain, announcePort) - - objectUrl = announceHttpsPrefix + '://' + announcedDomain + '/users/' + \ - announceNickname + '/statuses/' + str(announceStatusNumber) - - return announcePublic(session, baseDir, federationList, - nickname, domain, port, httpPrefix, - objectUrl, clientToServer, - sendThreads, postLog, - personCache, cachedWebfingers, - debug, projectVersion) - - -def undoAnnounce(session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, - toUrl: str, ccUrl: str, httpPrefix: str, - objectUrl: str, saveToFile: bool, - clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool) -> {}: - """Undoes an announce message - Typically toUrl will be https://www.w3.org/ns/activitystreams#Public - and ccUrl might be a specific person whose post was repeated and the - objectUrl is typically the url of the message which was repeated, - corresponding to url or atomUri in createPostBase - """ - if not urlPermitted(objectUrl, federationList): - return None - - if ':' in domain: - domain = domain.split(':')[0] - fullDomain = getFullDomain(domain, port) - - newUndoAnnounce = { - "@context": "https://www.w3.org/ns/activitystreams", - 'actor': httpPrefix+'://'+fullDomain+'/users/'+nickname, - 'type': 'Undo', - 'cc': [], - 'to': [toUrl], - 'object': { - 'actor': httpPrefix+'://'+fullDomain+'/users/'+nickname, - 'cc': [], - 'object': objectUrl, - 'to': [toUrl], - 'type': 'Announce' - } - } - if ccUrl: - if len(ccUrl) > 0: - newUndoAnnounce['object']['cc'] = [ccUrl] - - announceNickname = None - announceDomain = None - announcePort = None - if '/users/' in objectUrl or \ - '/accounts/' in objectUrl or \ - '/channel/' in objectUrl or \ - '/profile/' in objectUrl: - announceNickname = getNicknameFromActor(objectUrl) - announceDomain, announcePort = getDomainFromActor(objectUrl) - - if announceNickname and announceDomain: - sendSignedJson(newUndoAnnounce, session, baseDir, - nickname, domain, port, - announceNickname, announceDomain, announcePort, - 'https://www.w3.org/ns/activitystreams#Public', - httpPrefix, True, clientToServer, federationList, - sendThreads, postLog, cachedWebfingers, - personCache, debug) - - return newUndoAnnounce - - -def undoAnnouncePublic(session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, httpPrefix: str, - objectUrl: str, clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool) -> {}: - """Undoes a public announcement - """ - fromDomain = getFullDomain(domain, port) - - toUrl = 'https://www.w3.org/ns/activitystreams#Public' - ccUrl = httpPrefix + '://' + fromDomain + '/users/' + nickname + \ - '/followers' - return undoAnnounce(session, baseDir, federationList, - nickname, domain, port, - toUrl, ccUrl, httpPrefix, - objectUrl, True, clientToServer, - sendThreads, postLog, - personCache, cachedWebfingers, - debug) - - -def undoRepeatPost(session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, httpPrefix: str, - announceNickname: str, announceDomain: str, - announcePort: int, announceHttpsPrefix: str, - announceStatusNumber: int, clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool) -> {}: - """Undoes a status post repeat - """ - announcedDomain = getFullDomain(announceDomain, announcePort) - - objectUrl = announceHttpsPrefix + '://' + announcedDomain + '/users/' + \ - announceNickname + '/statuses/' + str(announceStatusNumber) - - return undoAnnouncePublic(session, baseDir, federationList, - nickname, domain, port, httpPrefix, - objectUrl, clientToServer, - sendThreads, postLog, - personCache, cachedWebfingers, - debug) - - def sendAnnounceViaServer(baseDir: str, session, fromNickname: str, password: str, fromDomain: str, fromPort: int, diff --git a/blog.py b/blog.py index 36fc1c4ed..2e167ace0 100644 --- a/blog.py +++ b/blog.py @@ -599,25 +599,6 @@ def htmlBlogPageRSS3(authorized: bool, session, return blogRSS3 -def getBlogIndexesForAccounts(baseDir: str) -> {}: - """ Get the index files for blogs for each account - and add them to a dict - """ - blogIndexes = {} - for subdir, dirs, files in os.walk(baseDir + '/accounts'): - for acct in dirs: - if '@' not in acct: - continue - if 'inbox@' in acct: - continue - accountDir = os.path.join(baseDir + '/accounts', acct) - blogsIndex = accountDir + '/tlblogs.index' - if os.path.isfile(blogsIndex): - blogIndexes[acct] = blogsIndex - break - return blogIndexes - - def noOfBlogAccounts(baseDir: str) -> int: """Returns the number of blog accounts """ diff --git a/blurhash.py b/blurhash.py index da7ce8d33..3e38d41f1 100644 --- a/blurhash.py +++ b/blurhash.py @@ -39,16 +39,6 @@ alphabet = \ alphabet_values = dict(zip(alphabet, range(len(alphabet)))) -def base83_decode(base83_str): - """ - Decodes a base83 string, as used in blurhash, to an integer. - """ - value = 0 - for base83_char in base83_str: - value = value * 83 + alphabet_values[base83_char] - return value - - def base83_encode(value, length): """ Decodes an integer to a base83 string, as used in blurhash. @@ -94,101 +84,6 @@ def linear_to_srgb(value): return int((1.055 * math.pow(value, 1 / 2.4) - 0.055) * 255 + 0.5) -def blurhash_components(blurhash): - """ - Decodes and returns the number of x and y components in the given blurhash. - """ - if len(blurhash) < 6: - raise ValueError("BlurHash must be at least 6 characters long.") - - # Decode metadata - size_info = base83_decode(blurhash[0]) - size_y = int(size_info / 9) + 1 - size_x = (size_info % 9) + 1 - - return size_x, size_y - - -def blurhash_decode(blurhash, width, height, punch=1.0, linear=False): - """ - Decodes the given blurhash to an image of the specified size. - - Returns the resulting image a list of lists of 3-value sRGB 8 bit integer - lists. Set linear to True if you would prefer to get linear floating point - RGB back. - - The punch parameter can be used to de- or increase the contrast of the - resulting image. - - As per the original implementation it is suggested to only decode - to a relatively small size and then scale the result up, as it - basically looks the same anyways. - """ - if len(blurhash) < 6: - raise ValueError("BlurHash must be at least 6 characters long.") - - # Decode metadata - size_info = base83_decode(blurhash[0]) - size_y = int(size_info / 9) + 1 - size_x = (size_info % 9) + 1 - - quant_max_value = base83_decode(blurhash[1]) - real_max_value = (float(quant_max_value + 1) / 166.0) * punch - - # Make sure we at least have the right number of characters - if len(blurhash) != 4 + 2 * size_x * size_y: - raise ValueError("Invalid BlurHash length.") - - # Decode DC component - dc_value = base83_decode(blurhash[2:6]) - colours = [( - srgb_to_linear(dc_value >> 16), - srgb_to_linear((dc_value >> 8) & 255), - srgb_to_linear(dc_value & 255) - )] - - # Decode AC components - for component in range(1, size_x * size_y): - ac_value = base83_decode(blurhash[4+component*2:4+(component+1)*2]) - colours.append(( - sign_pow((float(int(ac_value / (19 * 19))) - 9.0) - / 9.0, 2.0) * real_max_value, - sign_pow((float(int(ac_value / 19) % 19) - 9.0) - / 9.0, 2.0) * real_max_value, - sign_pow((float(ac_value % 19) - 9.0) - / 9.0, 2.0) * real_max_value - )) - - # Return image RGB values, as a list of lists of lists, - # consumable by something like numpy or PIL. - pixels = [] - for y in range(height): - pixel_row = [] - for x in range(width): - pixel = [0.0, 0.0, 0.0] - - for j in range(size_y): - for i in range(size_x): - basis = \ - math.cos(math.pi * float(x) * float(i) / - float(width)) * \ - math.cos(math.pi * float(y) * float(j) / float(height)) - colour = colours[i + j * size_x] - pixel[0] += colour[0] * basis - pixel[1] += colour[1] * basis - pixel[2] += colour[2] * basis - if linear is False: - pixel_row.append([ - linear_to_srgb(pixel[0]), - linear_to_srgb(pixel[1]), - linear_to_srgb(pixel[2]), - ]) - else: - pixel_row.append(pixel) - pixels.append(pixel_row) - return pixels - - def blurhash_encode(image, components_x=4, components_y=4, linear=False): """ Calculates the blurhash for an image using the given x and y diff --git a/bookmarks.py b/bookmarks.py index 75eeac47c..07000fa88 100644 --- a/bookmarks.py +++ b/bookmarks.py @@ -18,10 +18,6 @@ from utils import locatePost from utils import getCachedPostFilename from utils import loadJson from utils import saveJson -from session import postJson -from webfinger import webfingerHandle -from auth import createBasicAuthHeader -from posts import getPersonBox def undoBookmarksCollectionEntry(recentPostsCache: {}, @@ -283,32 +279,6 @@ def bookmark(recentPostsCache: {}, return newBookmarkJson -def bookmarkPost(recentPostsCache: {}, - session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, httpPrefix: str, - bookmarkNickname: str, bookmarkedomain: str, - bookmarkPort: int, - ccList: [], - bookmarkStatusNumber: int, clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool, projectVersion: str) -> {}: - """Bookmarks a given status post. This is only used by unit tests - """ - bookmarkedomain = getFullDomain(bookmarkedomain, bookmarkPort) - - actorBookmarked = httpPrefix + '://' + bookmarkedomain + \ - '/users/' + bookmarkNickname - objectUrl = actorBookmarked + '/statuses/' + str(bookmarkStatusNumber) - - return bookmark(recentPostsCache, - session, baseDir, federationList, nickname, domain, port, - ccList, httpPrefix, objectUrl, actorBookmarked, - clientToServer, - sendThreads, postLog, personCache, cachedWebfingers, - debug, projectVersion) - - def undoBookmark(recentPostsCache: {}, session, baseDir: str, federationList: [], nickname: str, domain: str, port: int, @@ -375,180 +345,6 @@ def undoBookmark(recentPostsCache: {}, return newUndoBookmarkJson -def undoBookmarkPost(session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, httpPrefix: str, - bookmarkNickname: str, bookmarkedomain: str, - bookmarkPort: int, ccList: [], - bookmarkStatusNumber: int, clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool) -> {}: - """Removes a bookmarked post - """ - bookmarkedomain = getFullDomain(bookmarkedomain, bookmarkPort) - - objectUrl = httpPrefix + '://' + bookmarkedomain + \ - '/users/' + bookmarkNickname + \ - '/statuses/' + str(bookmarkStatusNumber) - - return undoBookmark(session, baseDir, federationList, - nickname, domain, port, - ccList, httpPrefix, objectUrl, clientToServer, - sendThreads, postLog, personCache, - cachedWebfingers, debug) - - -def sendBookmarkViaServer(baseDir: str, session, - fromNickname: str, password: str, - fromDomain: str, fromPort: int, - httpPrefix: str, bookmarkUrl: str, - cachedWebfingers: {}, personCache: {}, - debug: bool, projectVersion: str) -> {}: - """Creates a bookmark via c2s - """ - if not session: - print('WARN: No session for sendBookmarkViaServer') - return 6 - - fromDomainFull = getFullDomain(fromDomain, fromPort) - - newBookmarkJson = { - "@context": "https://www.w3.org/ns/activitystreams", - 'type': 'Bookmark', - 'actor': httpPrefix+'://'+fromDomainFull+'/users/'+fromNickname, - 'object': bookmarkUrl - } - - handle = httpPrefix + '://' + fromDomainFull + '/@' + fromNickname - - # lookup the inbox for the To handle - wfRequest = webfingerHandle(session, handle, httpPrefix, - cachedWebfingers, - fromDomain, projectVersion) - if not wfRequest: - if debug: - print('DEBUG: announce webfinger failed for ' + handle) - return 1 - if not isinstance(wfRequest, dict): - print('WARN: Webfinger for ' + handle + ' did not return a dict. ' + - str(wfRequest)) - return 1 - - postToBox = 'outbox' - - # get the actor inbox for the To handle - (inboxUrl, pubKeyId, pubKey, - fromPersonId, sharedInbox, avatarUrl, - displayName) = getPersonBox(baseDir, session, wfRequest, personCache, - projectVersion, httpPrefix, fromNickname, - fromDomain, postToBox, 72483) - - if not inboxUrl: - if debug: - print('DEBUG: No ' + postToBox + ' was found for ' + handle) - return 3 - if not fromPersonId: - if debug: - print('DEBUG: No actor was found for ' + handle) - return 4 - - authHeader = createBasicAuthHeader(fromNickname, password) - - headers = { - 'host': fromDomain, - 'Content-type': 'application/json', - 'Authorization': authHeader - } - postResult = postJson(session, newBookmarkJson, [], - inboxUrl, headers) - if not postResult: - if debug: - print('DEBUG: POST announce failed for c2s to ' + inboxUrl) - return 5 - - if debug: - print('DEBUG: c2s POST bookmark success') - - return newBookmarkJson - - -def sendUndoBookmarkViaServer(baseDir: str, session, - fromNickname: str, password: str, - fromDomain: str, fromPort: int, - httpPrefix: str, bookmarkUrl: str, - cachedWebfingers: {}, personCache: {}, - debug: bool, projectVersion: str) -> {}: - """Undo a bookmark via c2s - """ - if not session: - print('WARN: No session for sendUndoBookmarkViaServer') - return 6 - - fromDomainFull = getFullDomain(fromDomain, fromPort) - - newUndoBookmarkJson = { - "@context": "https://www.w3.org/ns/activitystreams", - 'type': 'Undo', - 'actor': httpPrefix+'://'+fromDomainFull+'/users/'+fromNickname, - 'object': { - 'type': 'Bookmark', - 'actor': httpPrefix+'://'+fromDomainFull+'/users/'+fromNickname, - 'object': bookmarkUrl - } - } - - handle = httpPrefix + '://' + fromDomainFull + '/@' + fromNickname - - # lookup the inbox for the To handle - wfRequest = webfingerHandle(session, handle, httpPrefix, cachedWebfingers, - fromDomain, projectVersion) - if not wfRequest: - if debug: - print('DEBUG: announce webfinger failed for ' + handle) - return 1 - if not isinstance(wfRequest, dict): - print('WARN: Webfinger for ' + handle + ' did not return a dict. ' + - str(wfRequest)) - return 1 - - postToBox = 'outbox' - - # get the actor inbox for the To handle - (inboxUrl, pubKeyId, pubKey, - fromPersonId, sharedInbox, avatarUrl, - displayName) = getPersonBox(baseDir, session, wfRequest, personCache, - projectVersion, httpPrefix, fromNickname, - fromDomain, postToBox, 72528) - - if not inboxUrl: - if debug: - print('DEBUG: No ' + postToBox + ' was found for ' + handle) - return 3 - if not fromPersonId: - if debug: - print('DEBUG: No actor was found for ' + handle) - return 4 - - authHeader = createBasicAuthHeader(fromNickname, password) - - headers = { - 'host': fromDomain, - 'Content-type': 'application/json', - 'Authorization': authHeader - } - postResult = postJson(session, newUndoBookmarkJson, [], - inboxUrl, headers) - if not postResult: - if debug: - print('DEBUG: POST announce failed for c2s to ' + inboxUrl) - return 5 - - if debug: - print('DEBUG: c2s POST undo bookmark success') - - return newUndoBookmarkJson - - def outboxBookmark(recentPostsCache: {}, baseDir: str, httpPrefix: str, nickname: str, domain: str, port: int, diff --git a/content.py b/content.py index be9afd3ae..e86b62ea0 100644 --- a/content.py +++ b/content.py @@ -438,34 +438,6 @@ def addHashTags(wordStr: str, httpPrefix: str, domain: str, return True -def loadEmojiDict(emojiDataFilename: str, emojiDict: {}) -> None: - """Creates an emoji dictionary based on emoji/emoji-data.txt - """ - if not os.path.isfile(emojiDataFilename): - return - with open(emojiDataFilename, "r") as fileHandler: - for line in fileHandler: - if len(line) < 5: - continue - if line.startswith('#'): - continue - if '; Emoji' not in line: - continue - if ')' not in line: - continue - emojiUnicode = line.split(' ')[0] - if len(emojiUnicode) < 4: - continue - if '..' in emojiUnicode: - emojiUnicode = emojiUnicode.split('..')[0] - emojiName = line.split(')', 1)[1].strip() - emojiName = emojiName.replace('\n', '').replace('\r', '') - emojiName = emojiName.replace(' ', '').replace('-', '') - if '..' in emojiName: - emojiName = emojiName.split('..')[0] - emojiDict[emojiName.lower()] = emojiUnicode - - def addEmoji(baseDir: str, wordStr: str, httpPrefix: str, domain: str, replaceEmoji: {}, postTags: {}, diff --git a/daemon.py b/daemon.py index 8404c359e..3e4b362df 100644 --- a/daemon.py +++ b/daemon.py @@ -21,7 +21,6 @@ import pyqrcode from hashlib import sha256 from hashlib import sha1 from session import createSession -from webfinger import parseHandle from webfinger import webfingerMeta from webfinger import webfingerNodeInfo from webfinger import webfingerLookup @@ -275,22 +274,6 @@ def saveDomainQrcode(baseDir: str, httpPrefix: str, url.png(qrcodeFilename, scale) -def readFollowList(filename: str) -> None: - """Returns a list of ActivityPub addresses to follow - """ - followlist = [] - if not os.path.isfile(filename): - return followlist - followUsers = open(filename, "r") - for u in followUsers: - if u not in followlist: - nickname, domain = parseHandle(u) - if nickname: - followlist.append(nickname + '@' + domain) - followUsers.close() - return followlist - - class PubServer(BaseHTTPRequestHandler): protocol_version = 'HTTP/1.1' diff --git a/delete.py b/delete.py index 524004d8b..97b1aaa1c 100644 --- a/delete.py +++ b/delete.py @@ -10,82 +10,17 @@ import os from datetime import datetime from utils import getFullDomain from utils import removeIdEnding -from utils import getStatusNumber -from utils import urlPermitted from utils import getNicknameFromActor from utils import getDomainFromActor from utils import locatePost from utils import deletePost from utils import removeModerationPostFromIndex -from posts import sendSignedJson from session import postJson from webfinger import webfingerHandle from auth import createBasicAuthHeader from posts import getPersonBox -def createDelete(session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, - toUrl: str, ccUrl: str, httpPrefix: str, - objectUrl: str, clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool) -> {}: - """Creates a delete message - Typically toUrl will be https://www.w3.org/ns/activitystreams#Public - and ccUrl might be a specific person whose post is to be deleted - objectUrl is typically the url of the message, corresponding to url - or atomUri in createPostBase - """ - if not urlPermitted(objectUrl, federationList): - return None - - if ':' in domain: - domain = domain.split(':')[0] - fullDomain = domain - fullDomain = getFullDomain(domain, port) - - statusNumber, published = getStatusNumber() - newDeleteId = \ - httpPrefix + '://' + fullDomain + '/users/' + \ - nickname + '/statuses/' + statusNumber - newDelete = { - "@context": "https://www.w3.org/ns/activitystreams", - 'actor': httpPrefix+'://'+fullDomain+'/users/'+nickname, - 'atomUri': newDeleteId, - 'cc': [], - 'id': newDeleteId + '/activity', - 'object': objectUrl, - 'published': published, - 'to': [toUrl], - 'type': 'Delete' - } - if ccUrl: - if len(ccUrl) > 0: - newDelete['cc'] = [ccUrl] - - deleteNickname = None - deleteDomain = None - deletePort = None - if '/users/' in objectUrl or \ - '/accounts/' in objectUrl or \ - '/channel/' in objectUrl or \ - '/profile/' in objectUrl: - deleteNickname = getNicknameFromActor(objectUrl) - deleteDomain, deletePort = getDomainFromActor(objectUrl) - - if deleteNickname and deleteDomain: - sendSignedJson(newDelete, session, baseDir, - nickname, domain, port, - deleteNickname, deleteDomain, deletePort, - 'https://www.w3.org/ns/activitystreams#Public', - httpPrefix, True, clientToServer, federationList, - sendThreads, postLog, cachedWebfingers, - personCache, debug) - - return newDelete - - def sendDeleteViaServer(baseDir: str, session, fromNickname: str, password: str, fromDomain: str, fromPort: int, @@ -167,52 +102,6 @@ def sendDeleteViaServer(baseDir: str, session, return newDeleteJson -def deletePublic(session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, httpPrefix: str, - objectUrl: str, clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool) -> {}: - """Makes a public delete activity - """ - fromDomain = getFullDomain(domain, port) - - toUrl = 'https://www.w3.org/ns/activitystreams#Public' - ccUrl = httpPrefix + '://' + fromDomain + \ - '/users/' + nickname + '/followers' - return createDelete(session, baseDir, federationList, - nickname, domain, port, - toUrl, ccUrl, httpPrefix, - objectUrl, clientToServer, - sendThreads, postLog, - personCache, cachedWebfingers, - debug) - - -def deletePostPub(session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, httpPrefix: str, - deleteNickname: str, deleteDomain: str, - deletePort: int, deleteHttpsPrefix: str, - deleteStatusNumber: int, clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool) -> {}: - """Deletes a given status post - """ - deletedDomain = getFullDomain(deleteDomain, deletePort) - - objectUrl = \ - deleteHttpsPrefix + '://' + deletedDomain + '/users/' + \ - deleteNickname + '/statuses/' + str(deleteStatusNumber) - - return deletePublic(session, baseDir, federationList, - nickname, domain, port, httpPrefix, - objectUrl, clientToServer, - sendThreads, postLog, - personCache, cachedWebfingers, - debug) - - def outboxDelete(baseDir: str, httpPrefix: str, nickname: str, domain: str, messageJson: {}, debug: bool, diff --git a/inbox.py b/inbox.py index 653e539af..50722c2d5 100644 --- a/inbox.py +++ b/inbox.py @@ -313,15 +313,6 @@ def inboxPermittedMessage(domain: str, messageJson: {}, return True -def validPublishedDate(published: str) -> bool: - currTime = datetime.datetime.utcnow() - pubDate = datetime.datetime.strptime(published, "%Y-%m-%dT%H:%M:%SZ") - daysSincePublished = (currTime - pubDate).days - if daysSincePublished > 30: - return False - return True - - def savePostToInboxQueue(baseDir: str, httpPrefix: str, nickname: str, domain: str, postJsonObject: {}, diff --git a/like.py b/like.py index 7f59e6167..da83e1a51 100644 --- a/like.py +++ b/like.py @@ -141,76 +141,6 @@ def likePost(recentPostsCache: {}, debug, projectVersion) -def undolike(recentPostsCache: {}, - session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, - ccList: [], httpPrefix: str, - objectUrl: str, actorLiked: str, - clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool, projectVersion: str) -> {}: - """Removes a like - actor is the person doing the liking - 'to' might be a specific person (actor) whose post was liked - object is typically the url of the message which was liked - """ - if not urlPermitted(objectUrl, federationList): - return None - - fullDomain = getFullDomain(domain, port) - - newUndoLikeJson = { - "@context": "https://www.w3.org/ns/activitystreams", - 'type': 'Undo', - 'actor': httpPrefix + '://' + fullDomain + '/users/' + nickname, - 'object': { - 'type': 'Like', - 'actor': httpPrefix + '://' + fullDomain + '/users/' + nickname, - 'object': objectUrl - } - } - if ccList: - if len(ccList) > 0: - newUndoLikeJson['cc'] = ccList - newUndoLikeJson['object']['cc'] = ccList - - # Extract the domain and nickname from a statuses link - likedPostNickname = None - likedPostDomain = None - likedPostPort = None - if actorLiked: - likedPostNickname = getNicknameFromActor(actorLiked) - likedPostDomain, likedPostPort = getDomainFromActor(actorLiked) - else: - if '/users/' in objectUrl or \ - '/accounts/' in objectUrl or \ - '/channel/' in objectUrl or \ - '/profile/' in objectUrl: - likedPostNickname = getNicknameFromActor(objectUrl) - likedPostDomain, likedPostPort = getDomainFromActor(objectUrl) - - if likedPostNickname: - postFilename = locatePost(baseDir, nickname, domain, objectUrl) - if not postFilename: - return None - - undoLikesCollectionEntry(baseDir, postFilename, objectUrl, - newUndoLikeJson['actor'], domain, debug) - - sendSignedJson(newUndoLikeJson, session, baseDir, - nickname, domain, port, - likedPostNickname, likedPostDomain, likedPostPort, - 'https://www.w3.org/ns/activitystreams#Public', - httpPrefix, True, clientToServer, federationList, - sendThreads, postLog, cachedWebfingers, personCache, - debug, projectVersion) - else: - return None - - return newUndoLikeJson - - def sendLikeViaServer(baseDir: str, session, fromNickname: str, password: str, fromDomain: str, fromPort: int, diff --git a/media.py b/media.py index b7c0b849e..9d3308f80 100644 --- a/media.py +++ b/media.py @@ -6,7 +6,7 @@ __maintainer__ = "Bob Mottram" __email__ = "bob@freedombone.net" __status__ = "Production" -from blurhash import blurhash_encode as blurencode +from blurhash import blurhash_encode from PIL import Image import numpy import os @@ -57,7 +57,8 @@ def removeMetaData(imageFilename: str, outputFilename: str) -> None: def getImageHash(imageFilename: str) -> str: - return blurencode(numpy.array(Image.open(imageFilename).convert("RGB"))) + value = numpy.array(Image.open(imageFilename).convert("RGB")) + return blurhash_encode(value) def isMedia(imageFilename: str) -> bool: diff --git a/person.py b/person.py index 406700b29..6c847063c 100644 --- a/person.py +++ b/person.py @@ -722,48 +722,6 @@ def personBoxJson(recentPostsCache: {}, return None -def personInboxJson(recentPostsCache: {}, - baseDir: str, domain: str, port: int, path: str, - httpPrefix: str, noOfItems: int) -> []: - """Obtain the inbox feed for the given person - Authentication is expected to have already happened - """ - if '/inbox' not in path: - return None - - # Only show the header by default - headerOnly = True - - # handle page numbers - pageNumber = None - if '?page=' in path: - pageNumber = path.split('?page=')[1] - if pageNumber == 'true': - pageNumber = 1 - else: - try: - pageNumber = int(pageNumber) - except BaseException: - pass - path = path.split('?page=')[0] - headerOnly = False - - if not path.endswith('/inbox'): - return None - nickname = None - if path.startswith('/users/'): - nickname = path.replace('/users/', '', 1).replace('/inbox', '') - if path.startswith('/@'): - nickname = path.replace('/@', '', 1).replace('/inbox', '') - if not nickname: - return None - if not validNickname(domain, nickname): - return None - return createInbox(recentPostsCache, baseDir, nickname, - domain, port, httpPrefix, - noOfItems, headerOnly, pageNumber) - - def setDisplayNickname(baseDir: str, nickname: str, domain: str, displayName: str) -> bool: if len(displayName) > 32: diff --git a/posts.py b/posts.py index dc1d8dca3..647742994 100644 --- a/posts.py +++ b/posts.py @@ -1215,28 +1215,6 @@ def postIsAddressedToFollowers(baseDir: str, return addressedToFollowers -def postIsAddressedToPublic(baseDir: str, postJsonObject: {}) -> bool: - """Returns true if the given post is addressed to public - """ - if not postJsonObject.get('object'): - return False - if not postJsonObject['object'].get('to'): - return False - - publicUrl = 'https://www.w3.org/ns/activitystreams#Public' - - # does the public url exist in 'to' or 'cc' lists? - addressedToPublic = False - if publicUrl in postJsonObject['object']['to']: - addressedToPublic = True - if not addressedToPublic: - if not postJsonObject['object'].get('cc'): - return False - if publicUrl in postJsonObject['object']['cc']: - addressedToPublic = True - return addressedToPublic - - def createPublicPost(baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str, content: str, followersOnly: bool, saveToFile: bool, @@ -2737,17 +2715,6 @@ def createModeration(baseDir: str, nickname: str, domain: str, port: int, return boxItems -def getStatusNumberFromPostFilename(filename) -> int: - """Gets the status number from a post filename - eg. https:##testdomain.com:8085#users#testuser567# - statuses#1562958506952068.json - returns 156295850695206 - """ - if '#statuses#' not in filename: - return None - return int(filename.split('#')[-1].replace('.json', '')) - - def isDM(postJsonObject: {}) -> bool: """Returns true if the given post is a DM """ @@ -2849,66 +2816,6 @@ def isReply(postJsonObject: {}, actor: str) -> bool: return False -def createBoxIndex(boxDir: str, postsInBoxDict: {}) -> int: - """ Creates an index for the given box - """ - postsCtr = 0 - postsInPersonInbox = os.scandir(boxDir) - for postFilename in postsInPersonInbox: - postFilename = postFilename.name - if not postFilename.endswith('.json'): - continue - # extract the status number - statusNumber = getStatusNumberFromPostFilename(postFilename) - if statusNumber: - postsInBoxDict[statusNumber] = os.path.join(boxDir, postFilename) - postsCtr += 1 - return postsCtr - - -def createSharedInboxIndex(baseDir: str, sharedBoxDir: str, - postsInBoxDict: {}, postsCtr: int, - nickname: str, domain: str) -> int: - """ Creates an index for the given shared inbox - """ - handle = nickname + '@' + domain - followingFilename = baseDir + '/accounts/' + handle + '/following.txt' - postsInSharedInbox = os.scandir(sharedBoxDir) - followingHandles = None - for postFilename in postsInSharedInbox: - postFilename = postFilename.name - if not postFilename.endswith('.json'): - continue - statusNumber = getStatusNumberFromPostFilename(postFilename) - if not statusNumber: - continue - - sharedInboxFilename = os.path.join(sharedBoxDir, postFilename) - # get the actor from the shared post - postJsonObject = loadJson(sharedInboxFilename, 0) - if not postJsonObject: - print('WARN: json load exception createSharedInboxIndex') - continue - - actorNickname = getNicknameFromActor(postJsonObject['actor']) - if not actorNickname: - continue - actorDomain, actorPort = getDomainFromActor(postJsonObject['actor']) - if not actorDomain: - continue - - # is the actor followed by this account? - if not followingHandles: - with open(followingFilename, 'r') as followingFile: - followingHandles = followingFile.read() - if actorNickname + '@' + actorDomain not in followingHandles: - continue - - postsInBoxDict[statusNumber] = sharedInboxFilename - postsCtr += 1 - return postsCtr - - def addPostStringToTimeline(postStr: str, boxname: str, postsInBox: [], boxActor: str) -> bool: """ is this a valid timeline post? diff --git a/skills.py b/skills.py index 2637acd78..bbd221eb9 100644 --- a/skills.py +++ b/skills.py @@ -41,17 +41,6 @@ def setSkillLevel(baseDir: str, nickname: str, domain: str, return True -def setSkills(baseDir: str, nickname: str, domain: str, skills: {}) -> None: - actorFilename = baseDir + '/accounts/' + nickname + '@' + domain + '.json' - if not os.path.isfile(actorFilename): - return False - - actorJson = loadJson(actorFilename) - if actorJson: - actorJson['skills'] = skills - saveJson(actorJson, actorFilename) - - def getSkills(baseDir: str, nickname: str, domain: str) -> []: """Returns the skills for a given person """ diff --git a/tests.py b/tests.py index ca0d1bbc2..bc84d9a00 100644 --- a/tests.py +++ b/tests.py @@ -2533,8 +2533,102 @@ def testReplyToPublicPost() -> None: httpPrefix + '://rat.site/users/ninjarodent' +def testFunctions(): + print('testFunctions') + function = {} + functionProperties = {} + modules = [] + + for subdir, dirs, files in os.walk('.'): + for sourceFile in files: + if not sourceFile.endswith('.py'): + continue + modName = sourceFile.replace('.py', '') + modules.append(modName) + sourceStr = '' + with open(sourceFile, "r") as f: + sourceStr = f.read() + with open(sourceFile, "r") as f: + lines = f.readlines() + for line in lines: + if not line.startswith('def '): + continue + methodName = line.split('def ', 1)[1].split('(')[0] + methodArgs = \ + sourceStr.split('def ' + methodName + '(')[1] + methodArgs = methodArgs.split(')')[0] + methodArgs = methodArgs.replace(' ', '').split(',') + if function.get(modName): + function[modName].append(methodName) + else: + function[modName] = [methodName] + functionProperties[methodName] = { + "args": methodArgs, + "module": modName, + "calledInModule": [] + } + break + + # which modules is each function used within? + for modName in modules: + with open(modName + '.py', "r") as f: + lines = f.readlines() + for name, properties in functionProperties.items(): + for line in lines: + if line.startswith('def '): + continue + if name + '(' in line: + modList = \ + functionProperties[name]['calledInModule'] + if modName not in modList: + modList.append(modName) + + # don't check these functions, because they are procedurally called + exclusions = [ + 'set_document_loader', + 'normalize', + 'get_document_loader', + 'runInboxQueueWatchdog', + 'runInboxQueue', + 'runPostSchedule', + 'runPostScheduleWatchdog', + 'str2bool', + 'runNewswireDaemon', + 'runNewswireWatchdog', + 'threadSendPost', + 'sendToFollowers', + 'expireCache', + 'migrateAccount', + 'getMutualsOfPerson', + 'runPostsQueue', + 'runSharesExpire', + 'runPostsWatchdog', + 'runSharesExpireWatchdog', + 'getThisWeeksEvents', + 'getAvailability', + 'testThreadsFunction', + 'createServerAlice', + 'createServerBob', + 'createServerEve', + 'E2EEremoveDevice', + 'setOrganizationScheme' + ] + # check that functions are called somewhere + for name, properties in functionProperties.items(): + if name in exclusions: + continue + if not properties['calledInModule']: + print('function ' + name + + ' in module ' + properties['module'] + + ' is not called anywhere') + assert properties['calledInModule'] + # print(str(function)) + # print(str(functionProperties)) + + def runAllTests(): print('Running tests...') + testFunctions() testReplyToPublicPost() testGetMentionedPeople() testGuessHashtagCategory() diff --git a/theme.py b/theme.py index bc34fe1c3..7f609b948 100644 --- a/theme.py +++ b/theme.py @@ -398,39 +398,6 @@ def setThemeDefault(baseDir: str, allowLocalNetworkAccess: bool): allowLocalNetworkAccess) -def setThemeHighVis(baseDir: str, allowLocalNetworkAccess: bool): - name = 'highvis' - themeParams = { - "newswire-publish-icon": True, - "full-width-timeline-buttons": False, - "icons-as-buttons": False, - "rss-icon-at-top": True, - "publish-button-at-top": False, - "font-size-header": "22px", - "font-size-header-mobile": "32px", - "font-size": "45px", - "font-size2": "45px", - "font-size3": "45px", - "font-size4": "35px", - "font-size5": "29px", - "gallery-font-size": "35px", - "gallery-font-size-mobile": "55px", - "hashtag-vertical-spacing3": "100px", - "hashtag-vertical-spacing4": "150px", - "time-vertical-align": "-10px", - "*font-family": "'LinBiolinum_Rah'", - "*src": "url('./fonts/LinBiolinum_Rah.woff2') format('woff2')" - } - bgParams = { - "login": "jpg", - "follow": "jpg", - "options": "jpg", - "search": "jpg" - } - setThemeFromDict(baseDir, name, themeParams, bgParams, - allowLocalNetworkAccess) - - def setThemeFonts(baseDir: str, themeName: str) -> None: """Adds custom theme fonts """ diff --git a/webapp_utils.py b/webapp_utils.py index a6957780b..baa2cb0cd 100644 --- a/webapp_utils.py +++ b/webapp_utils.py @@ -542,16 +542,6 @@ def htmlFooter() -> str: return htmlStr -def getFontFromCss(css: str) -> (str, str): - """Returns the font name and format - """ - if ' url(' not in css: - return None, None - fontName = css.split(" url(")[1].split(")")[0].replace("'", '') - fontFormat = css.split(" format('")[1].split("')")[0] - return fontName, fontFormat - - def loadIndividualPostAsHtmlFromCache(baseDir: str, nickname: str, domain: str, postJsonObject: {}) -> str: From 59357c0c4f923b5236b26e5ae80c314d4b8d51f7 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 13:04:49 +0000 Subject: [PATCH 05/17] More verbose module checks --- tests.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests.py b/tests.py index bc84d9a00..edf17efaa 100644 --- a/tests.py +++ b/tests.py @@ -2571,6 +2571,7 @@ def testFunctions(): # which modules is each function used within? for modName in modules: + print('Module: ' + modName + ' ✓') with open(modName + '.py', "r") as f: lines = f.readlines() for name, properties in functionProperties.items(): @@ -2622,6 +2623,7 @@ def testFunctions(): ' in module ' + properties['module'] + ' is not called anywhere') assert properties['calledInModule'] + print('Function: ' + name + ' ✓') # print(str(function)) # print(str(functionProperties)) From 0cf0841402681ddc5cd51ef07236374a07f130c1 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 13:57:24 +0000 Subject: [PATCH 06/17] Check that imports are correct --- daemon.py | 8 ++++---- follow.py | 24 ++++++++++++------------ inbox.py | 14 +++++++------- tests.py | 21 ++++++++++++++++----- 4 files changed, 39 insertions(+), 28 deletions(-) diff --git a/daemon.py b/daemon.py index 3e4b362df..d89edd841 100644 --- a/daemon.py +++ b/daemon.py @@ -87,7 +87,7 @@ from inbox import populateReplies from inbox import getPersonPubKey from follow import getFollowingFeed from follow import sendFollowRequest -from follow import unfollowPerson +from follow import unfollowAccount from follow import createInitialLastSeen from auth import authorize from auth import createPassword @@ -2115,9 +2115,9 @@ class PubServer(BaseHTTPRequestHandler): } pathUsersSection = path.split('/users/')[1] self.postToNickname = pathUsersSection.split('/')[0] - unfollowPerson(self.server.baseDir, self.postToNickname, - self.server.domain, - followingNickname, followingDomainFull) + unfollowAccount(self.server.baseDir, self.postToNickname, + self.server.domain, + followingNickname, followingDomainFull) self._postToOutboxThread(unfollowJson) if callingDomain.endswith('.onion') and onionDomain: diff --git a/follow.py b/follow.py index 441d02fdf..2a765b15e 100644 --- a/follow.py +++ b/follow.py @@ -212,10 +212,10 @@ def isFollowerOfPerson(baseDir: str, nickname: str, domain: str, return alreadyFollowing -def unfollowPerson(baseDir: str, nickname: str, domain: str, - followNickname: str, followDomain: str, - followFile='following.txt', - debug=False) -> bool: +def unfollowAccount(baseDir: str, nickname: str, domain: str, + followNickname: str, followDomain: str, + followFile='following.txt', + debug=False) -> bool: """Removes a person to the follow list """ if ':' in domain: @@ -261,14 +261,14 @@ def unfollowPerson(baseDir: str, nickname: str, domain: str, return True -def unfollowerOfPerson(baseDir: str, nickname: str, domain: str, - followerNickname: str, followerDomain: str, - debug=False) -> bool: +def unfollowerOfAccount(baseDir: str, nickname: str, domain: str, + followerNickname: str, followerDomain: str, + debug=False) -> bool: """Remove a follower of a person """ - return unfollowPerson(baseDir, nickname, domain, - followerNickname, followerDomain, - 'followers.txt', debug) + return unfollowAccount(baseDir, nickname, domain, + followerNickname, followerDomain, + 'followers.txt', debug) def clearFollows(baseDir: str, nickname: str, domain: str, @@ -1208,8 +1208,8 @@ def outboxUndoFollow(baseDir: str, messageJson: {}, debug: bool) -> None: getDomainFromActor(messageJson['object']['object']) domainFollowingFull = getFullDomain(domainFollowing, portFollowing) - if unfollowPerson(baseDir, nicknameFollower, domainFollowerFull, - nicknameFollowing, domainFollowingFull): + if unfollowAccount(baseDir, nicknameFollower, domainFollowerFull, + nicknameFollowing, domainFollowingFull): if debug: print('DEBUG: ' + nicknameFollower + ' unfollowed ' + nicknameFollowing + '@' + domainFollowingFull) diff --git a/inbox.py b/inbox.py index 50722c2d5..7be1f1a4d 100644 --- a/inbox.py +++ b/inbox.py @@ -39,7 +39,7 @@ from session import createSession from session import getJson from follow import receiveFollowRequest from follow import getFollowersOfActor -from follow import unfollowerOfPerson +from follow import unfollowerOfAccount from pprint import pprint from cache import getPersonFromCache from cache import storePersonInCache @@ -49,8 +49,8 @@ from bookmarks import undoBookmarksCollectionEntry from blocking import isBlocked from blocking import isBlockedDomain from filters import isFiltered -from announce import updateAnnounceCollection -from announce import undoAnnounceCollectionEntry +from utils import updateAnnounceCollection +from utils import undoAnnounceCollectionEntry from httpsig import messageContentDigest from posts import validContentWarning from posts import downloadAnnounce @@ -637,10 +637,10 @@ def receiveUndoFollow(session, baseDir: str, httpPrefix: str, getDomainFromActor(messageJson['object']['object']) domainFollowingFull = getFullDomain(domainFollowing, portFollowing) - if unfollowerOfPerson(baseDir, - nicknameFollowing, domainFollowingFull, - nicknameFollower, domainFollowerFull, - debug): + if unfollowerOfAccount(baseDir, + nicknameFollowing, domainFollowingFull, + nicknameFollower, domainFollowerFull, + debug): print(nicknameFollowing + '@' + domainFollowingFull + ': ' 'Follower ' + nicknameFollower + '@' + domainFollowerFull + ' was removed') diff --git a/tests.py b/tests.py index edf17efaa..461d03323 100644 --- a/tests.py +++ b/tests.py @@ -49,8 +49,8 @@ from utils import getStatusNumber from utils import getFollowersOfPerson from utils import removeHtml from follow import followerOfPerson -from follow import unfollowPerson -from follow import unfollowerOfPerson +from follow import unfollowAccount +from follow import unfollowerOfAccount from follow import sendFollowRequest from person import createPerson from person import setDisplayNickname @@ -73,7 +73,7 @@ from delete import sendDeleteViaServer from inbox import jsonPostAllowsComments from inbox import validInbox from inbox import validInboxFilenames -from inbox import guessHashtagCategory +from categories import guessHashtagCategory from content import htmlReplaceEmailQuote from content import htmlReplaceQuoteMarks from content import dangerousMarkup @@ -978,7 +978,7 @@ def testNoOfFollowersOnDomain(): noOfFollowersOnDomain(baseDir, nickname + '@' + domain, otherdomain) assert followersOnOtherDomain == 3 - unfollowerOfPerson(baseDir, nickname, domain, 'sausagedog', otherdomain) + unfollowerOfAccount(baseDir, nickname, domain, 'sausagedog', otherdomain) followersOnOtherDomain = \ noOfFollowersOnDomain(baseDir, nickname + '@' + domain, otherdomain) assert followersOnOtherDomain == 2 @@ -1074,7 +1074,7 @@ def testFollows(): assert(False) assert(domainFound) - unfollowPerson(baseDir, nickname, domain, 'batman', 'mesh.com') + unfollowAccount(baseDir, nickname, domain, 'batman', 'mesh.com') domainFound = False for followingDomain in f: @@ -2614,6 +2614,9 @@ def testFunctions(): 'E2EEremoveDevice', 'setOrganizationScheme' ] + excludeImports = [ + 'link' + ] # check that functions are called somewhere for name, properties in functionProperties.items(): if name in exclusions: @@ -2623,6 +2626,14 @@ def testFunctions(): ' in module ' + properties['module'] + ' is not called anywhere') assert properties['calledInModule'] + if name not in excludeImports: + for modName in properties['calledInModule']: + if modName == properties['module']: + continue + importStr = 'from ' + properties['module'] + ' import ' + name + if importStr not in open(modName + '.py').read(): + print(importStr + ' not found in ' + modName + '.py') + assert False print('Function: ' + name + ' ✓') # print(str(function)) # print(str(functionProperties)) From 5cd9aa8d66709c878de5b59429401ab1064c53ce Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 18:06:23 +0000 Subject: [PATCH 07/17] Enforce convention of underscore before local function names --- acceptreject.py | 30 +- auth.py | 12 +- blog.py | 129 ++++---- blurhash.py | 34 +- bookmarks.py | 4 +- content.py | 62 ++-- donate.py | 6 +- filters.py | 10 +- follow.py | 140 ++++---- followingCalendar.py | 16 +- git.py | 26 +- happening.py | 32 +- httpsig.py | 6 +- inbox.py | 678 +++++++++++++++++++-------------------- jsonldsig.py | 36 +-- like.py | 28 +- manualapprove.py | 4 +- media.py | 12 +- migrate.py | 8 +- newsdaemon.py | 108 +++---- newswire.py | 248 +++++++-------- person.py | 34 +- petnames.py | 6 +- posts.py | 565 ++++++++++++++++----------------- roles.py | 22 +- schedule.py | 6 +- shares.py | 4 +- tests.py | 23 +- theme.py | 108 +++---- utils.py | 27 +- webapp_calendar.py | 18 +- webapp_column_left.py | 20 +- webapp_column_right.py | 14 +- webapp_create_post.py | 62 ++-- webapp_frontscreen.py | 32 +- webapp_hashtagswarm.py | 8 +- webapp_media.py | 16 +- webapp_post.py | 703 +++++++++++++++++++++-------------------- webapp_profile.py | 198 ++++++------ webapp_timeline.py | 48 +-- webapp_utils.py | 36 +-- webfinger.py | 12 +- 42 files changed, 1805 insertions(+), 1786 deletions(-) diff --git a/acceptreject.py b/acceptreject.py index bd6c7f366..6aa4fc3d0 100644 --- a/acceptreject.py +++ b/acceptreject.py @@ -15,10 +15,10 @@ from utils import domainPermitted from utils import followPerson -def createAcceptReject(baseDir: str, federationList: [], - nickname: str, domain: str, port: int, - toUrl: str, ccUrl: str, httpPrefix: str, - objectJson: {}, acceptType: str) -> {}: +def _createAcceptReject(baseDir: str, federationList: [], + nickname: str, domain: str, port: int, + toUrl: str, ccUrl: str, httpPrefix: str, + objectJson: {}, acceptType: str) -> {}: """Accepts or rejects something (eg. a follow request or offer) Typically toUrl will be https://www.w3.org/ns/activitystreams#Public and ccUrl might be a specific person favorited or repeated and @@ -51,24 +51,24 @@ def createAccept(baseDir: str, federationList: [], nickname: str, domain: str, port: int, toUrl: str, ccUrl: str, httpPrefix: str, objectJson: {}) -> {}: - return createAcceptReject(baseDir, federationList, - nickname, domain, port, - toUrl, ccUrl, httpPrefix, - objectJson, 'Accept') + return _createAcceptReject(baseDir, federationList, + nickname, domain, port, + toUrl, ccUrl, httpPrefix, + objectJson, 'Accept') def createReject(baseDir: str, federationList: [], nickname: str, domain: str, port: int, toUrl: str, ccUrl: str, httpPrefix: str, objectJson: {}) -> {}: - return createAcceptReject(baseDir, federationList, - nickname, domain, port, - toUrl, ccUrl, - httpPrefix, objectJson, 'Reject') + return _createAcceptReject(baseDir, federationList, + nickname, domain, port, + toUrl, ccUrl, + httpPrefix, objectJson, 'Reject') -def acceptFollow(baseDir: str, domain: str, messageJson: {}, - federationList: [], debug: bool) -> None: +def _acceptFollow(baseDir: str, domain: str, messageJson: {}, + federationList: [], debug: bool) -> None: """Receiving a follow Accept activity """ if not messageJson.get('object'): @@ -204,7 +204,7 @@ def receiveAcceptReject(session, baseDir: str, ' does not contain a nickname. ' + 'Assuming single user instance.') # receive follow accept - acceptFollow(baseDir, domain, messageJson, federationList, debug) + _acceptFollow(baseDir, domain, messageJson, federationList, debug) if debug: print('DEBUG: Uh, ' + messageJson['type'] + ', I guess') return True diff --git a/auth.py b/auth.py index f0124f550..841141279 100644 --- a/auth.py +++ b/auth.py @@ -14,7 +14,7 @@ import secrets from utils import isSystemAccount -def hashPassword(password: str) -> str: +def _hashPassword(password: str) -> str: """Hash a password for storing """ salt = hashlib.sha256(os.urandom(60)).hexdigest().encode('ascii') @@ -25,7 +25,7 @@ def hashPassword(password: str) -> str: return (salt + pwdhash).decode('ascii') -def getPasswordHash(salt: str, providedPassword: str) -> str: +def _getPasswordHash(salt: str, providedPassword: str) -> str: """Returns the hash of a password """ pwdhash = hashlib.pbkdf2_hmac('sha512', @@ -57,7 +57,7 @@ def constantTimeStringCheck(string1: str, string2: str) -> bool: return matched -def verifyPassword(storedPassword: str, providedPassword: str) -> bool: +def _verifyPassword(storedPassword: str, providedPassword: str) -> bool: """Verify a stored password against one provided by user """ if not storedPassword: @@ -66,7 +66,7 @@ def verifyPassword(storedPassword: str, providedPassword: str) -> bool: return False salt = storedPassword[:64] storedPassword = storedPassword[64:] - pwHash = getPasswordHash(salt, providedPassword) + pwHash = _getPasswordHash(salt, providedPassword) return constantTimeStringCheck(pwHash, storedPassword) @@ -137,7 +137,7 @@ def authorizeBasic(baseDir: str, path: str, authHeader: str, if line.startswith(nickname+':'): storedPassword = \ line.split(':')[1].replace('\n', '').replace('\r', '') - success = verifyPassword(storedPassword, providedPassword) + success = _verifyPassword(storedPassword, providedPassword) if not success: if debug: print('DEBUG: Password check failed for ' + nickname) @@ -159,7 +159,7 @@ def storeBasicCredentials(baseDir: str, nickname: str, password: str) -> bool: os.mkdir(baseDir + '/accounts') passwordFile = baseDir + '/accounts/passwords' - storeStr = nickname + ':' + hashPassword(password) + storeStr = nickname + ':' + _hashPassword(password) if os.path.isfile(passwordFile): if nickname + ':' in open(passwordFile).read(): with open(passwordFile, "r") as fin: diff --git a/blog.py b/blog.py index 2e167ace0..ec92e825a 100644 --- a/blog.py +++ b/blog.py @@ -26,9 +26,9 @@ from newswire import rss2Header from newswire import rss2Footer -def noOfBlogReplies(baseDir: str, httpPrefix: str, translate: {}, - nickname: str, domain: str, domainFull: str, - postId: str, depth=0) -> int: +def _noOfBlogReplies(baseDir: str, httpPrefix: str, translate: {}, + nickname: str, domain: str, domainFull: str, + postId: str, depth=0) -> int: """Returns the number of replies on the post This is recursive, so can handle replies to replies """ @@ -66,9 +66,10 @@ def noOfBlogReplies(baseDir: str, httpPrefix: str, translate: {}, replyPostId = replyPostId.replace('.json', '') if locatePost(baseDir, nickname, domain, replyPostId): replyPostId = replyPostId.replace('.replies', '') - replies += 1 + noOfBlogReplies(baseDir, httpPrefix, translate, - nickname, domain, domainFull, - replyPostId, depth+1) + replies += \ + 1 + _noOfBlogReplies(baseDir, httpPrefix, translate, + nickname, domain, domainFull, + replyPostId, depth+1) else: # remove post which no longer exists removals.append(replyPostId) @@ -86,9 +87,9 @@ def noOfBlogReplies(baseDir: str, httpPrefix: str, translate: {}, return replies -def getBlogReplies(baseDir: str, httpPrefix: str, translate: {}, - nickname: str, domain: str, domainFull: str, - postId: str, depth=0) -> str: +def _getBlogReplies(baseDir: str, httpPrefix: str, translate: {}, + nickname: str, domain: str, domainFull: str, + postId: str, depth=0) -> str: """Returns a string containing html blog posts """ if depth > 4: @@ -136,9 +137,9 @@ def getBlogReplies(baseDir: str, httpPrefix: str, translate: {}, continue with open(postFilename, "r") as postFile: repliesStr += postFile.read() + '\n' - rply = getBlogReplies(baseDir, httpPrefix, translate, - nickname, domain, domainFull, - replyPostId, depth+1) + rply = _getBlogReplies(baseDir, httpPrefix, translate, + nickname, domain, domainFull, + replyPostId, depth+1) if rply not in repliesStr: repliesStr += rply @@ -152,12 +153,12 @@ def getBlogReplies(baseDir: str, httpPrefix: str, translate: {}, return '' -def htmlBlogPostContent(authorized: bool, - baseDir: str, httpPrefix: str, translate: {}, - nickname: str, domain: str, domainFull: str, - postJsonObject: {}, - handle: str, restrictToDomain: bool, - blogSeparator='
') -> str: +def _htmlBlogPostContent(authorized: bool, + baseDir: str, httpPrefix: str, translate: {}, + nickname: str, domain: str, domainFull: str, + postJsonObject: {}, + handle: str, restrictToDomain: bool, + blogSeparator='
') -> str: """Returns the content for a single blog post """ linkedAuthor = False @@ -269,9 +270,9 @@ def htmlBlogPostContent(authorized: bool, '/users/' + nickname + '">' + translate['About the author'] + \ '

\n' - replies = noOfBlogReplies(baseDir, httpPrefix, translate, - nickname, domain, domainFull, - postJsonObject['object']['id']) + replies = _noOfBlogReplies(baseDir, httpPrefix, translate, + nickname, domain, domainFull, + postJsonObject['object']['id']) # separator between blogs should be centered if '
' not in blogSeparator: @@ -288,23 +289,23 @@ def htmlBlogPostContent(authorized: bool, else: blogStr += blogSeparator + '

' + translate['Replies'] + '

\n' if not titleStr: - blogStr += getBlogReplies(baseDir, httpPrefix, translate, - nickname, domain, domainFull, - postJsonObject['object']['id']) + blogStr += _getBlogReplies(baseDir, httpPrefix, translate, + nickname, domain, domainFull, + postJsonObject['object']['id']) else: - blogRepliesStr = getBlogReplies(baseDir, httpPrefix, translate, - nickname, domain, domainFull, - postJsonObject['object']['id']) + blogRepliesStr = _getBlogReplies(baseDir, httpPrefix, translate, + nickname, domain, domainFull, + postJsonObject['object']['id']) blogStr += blogRepliesStr.replace('>' + titleStr + '<', '') return blogStr -def htmlBlogPostRSS2(authorized: bool, - baseDir: str, httpPrefix: str, translate: {}, - nickname: str, domain: str, domainFull: str, - postJsonObject: {}, - handle: str, restrictToDomain: bool) -> str: +def _htmlBlogPostRSS2(authorized: bool, + baseDir: str, httpPrefix: str, translate: {}, + nickname: str, domain: str, domainFull: str, + postJsonObject: {}, + handle: str, restrictToDomain: bool) -> str: """Returns the RSS version 2 feed for a single blog post """ rssStr = '' @@ -331,11 +332,11 @@ def htmlBlogPostRSS2(authorized: bool, return rssStr -def htmlBlogPostRSS3(authorized: bool, - baseDir: str, httpPrefix: str, translate: {}, - nickname: str, domain: str, domainFull: str, - postJsonObject: {}, - handle: str, restrictToDomain: bool) -> str: +def _htmlBlogPostRSS3(authorized: bool, + baseDir: str, httpPrefix: str, translate: {}, + nickname: str, domain: str, domainFull: str, + postJsonObject: {}, + handle: str, restrictToDomain: bool) -> str: """Returns the RSS version 3 feed for a single blog post """ rssStr = '' @@ -359,7 +360,7 @@ def htmlBlogPostRSS3(authorized: bool, return rssStr -def htmlBlogRemoveCwButton(blogStr: str, translate: {}) -> str: +def _htmlBlogRemoveCwButton(blogStr: str, translate: {}) -> str: """Removes the CW button from blog posts, where the summary field is instead used as the blog title """ @@ -383,13 +384,13 @@ def htmlBlogPost(authorized: bool, if os.path.isfile(baseDir + '/blog.css'): cssFilename = baseDir + '/blog.css' blogStr = htmlHeaderWithExternalStyle(cssFilename) - htmlBlogRemoveCwButton(blogStr, translate) + _htmlBlogRemoveCwButton(blogStr, translate) - blogStr += htmlBlogPostContent(authorized, baseDir, - httpPrefix, translate, - nickname, domain, - domainFull, postJsonObject, - None, False) + blogStr += _htmlBlogPostContent(authorized, baseDir, + httpPrefix, translate, + nickname, domain, + domainFull, postJsonObject, + None, False) # show rss links blogStr += '

' @@ -428,7 +429,7 @@ def htmlBlogPage(authorized: bool, session, if os.path.isfile(baseDir + '/epicyon.css'): cssFilename = baseDir + '/epicyon.css' blogStr = htmlHeaderWithExternalStyle(cssFilename) - htmlBlogRemoveCwButton(blogStr, translate) + _htmlBlogRemoveCwButton(blogStr, translate) blogsIndex = baseDir + '/accounts/' + \ nickname + '@' + domain + '/tlblogs.index' @@ -472,11 +473,11 @@ def htmlBlogPage(authorized: bool, session, if item['type'] != 'Create': continue - blogStr += htmlBlogPostContent(authorized, baseDir, - httpPrefix, translate, - nickname, domain, - domainFull, item, - None, True) + blogStr += _htmlBlogPostContent(authorized, baseDir, + httpPrefix, translate, + nickname, domain, + domainFull, item, + None, True) if len(timelineJson['orderedItems']) >= noOfItems: blogStr += navigateStr @@ -544,11 +545,11 @@ def htmlBlogPageRSS2(authorized: bool, session, continue blogRSS2 += \ - htmlBlogPostRSS2(authorized, baseDir, - httpPrefix, translate, - nickname, domain, - domainFull, item, - None, True) + _htmlBlogPostRSS2(authorized, baseDir, + httpPrefix, translate, + nickname, domain, + domainFull, item, + None, True) if includeHeader: return blogRSS2 + rss2Footer() @@ -590,16 +591,16 @@ def htmlBlogPageRSS3(authorized: bool, session, continue blogRSS3 += \ - htmlBlogPostRSS3(authorized, baseDir, - httpPrefix, translate, - nickname, domain, - domainFull, item, - None, True) + _htmlBlogPostRSS3(authorized, baseDir, + httpPrefix, translate, + nickname, domain, + domainFull, item, + None, True) return blogRSS3 -def noOfBlogAccounts(baseDir: str) -> int: +def _noOfBlogAccounts(baseDir: str) -> int: """Returns the number of blog accounts """ ctr = 0 @@ -617,7 +618,7 @@ def noOfBlogAccounts(baseDir: str) -> int: return ctr -def singleBlogAccountNickname(baseDir: str) -> str: +def _singleBlogAccountNickname(baseDir: str) -> str: """Returns the nickname of a single blog account """ for subdir, dirs, files in os.walk(baseDir + '/accounts'): @@ -647,8 +648,8 @@ def htmlBlogView(authorized: bool, cssFilename = baseDir + '/epicyon.css' blogStr = htmlHeaderWithExternalStyle(cssFilename) - if noOfBlogAccounts(baseDir) <= 1: - nickname = singleBlogAccountNickname(baseDir) + if _noOfBlogAccounts(baseDir) <= 1: + nickname = _singleBlogAccountNickname(baseDir) if nickname: return htmlBlogPage(authorized, session, baseDir, httpPrefix, translate, diff --git a/blurhash.py b/blurhash.py index 3e38d41f1..7728c8399 100644 --- a/blurhash.py +++ b/blurhash.py @@ -39,7 +39,7 @@ alphabet = \ alphabet_values = dict(zip(alphabet, range(len(alphabet)))) -def base83_encode(value, length): +def _base83_encode(value, length): """ Decodes an integer to a base83 string, as used in blurhash. @@ -57,7 +57,7 @@ def base83_encode(value, length): return result -def srgb_to_linear(value): +def _srgb_to_linear(value): """ srgb 0-255 integer to linear 0.0-1.0 floating point conversion. """ @@ -67,14 +67,14 @@ def srgb_to_linear(value): return math.pow((value + 0.055) / 1.055, 2.4) -def sign_pow(value, exp): +def _sign_pow(value, exp): """ Sign-preserving exponentiation. """ return math.copysign(math.pow(abs(value), exp), value) -def linear_to_srgb(value): +def _linear_to_srgb(value): """ linear 0.0-1.0 floating point to srgb 0-255 integer conversion. """ @@ -113,9 +113,9 @@ def blurhash_encode(image, components_x=4, components_y=4, linear=False): image_linear_line = [] for x in range(int(width)): image_linear_line.append([ - srgb_to_linear(image[y][x][0]), - srgb_to_linear(image[y][x][1]), - srgb_to_linear(image[y][x][2]) + _srgb_to_linear(image[y][x][0]), + _srgb_to_linear(image[y][x][1]), + _srgb_to_linear(image[y][x][2]) ]) image_linear.append(image_linear_line) else: @@ -149,9 +149,9 @@ def blurhash_encode(image, components_x=4, components_y=4, linear=False): abs(component[1]), abs(component[2])) # Encode components - dc_value = (linear_to_srgb(components[0][0]) << 16) + \ - (linear_to_srgb(components[0][1]) << 8) + \ - linear_to_srgb(components[0][2]) + dc_value = (_linear_to_srgb(components[0][0]) << 16) + \ + (_linear_to_srgb(components[0][1]) << 8) + \ + _linear_to_srgb(components[0][2]) quant_max_ac_component = int(max(0, min(82, math.floor(max_ac_component * @@ -163,9 +163,9 @@ def blurhash_encode(image, components_x=4, components_y=4, linear=False): r2 = r / ac_component_norm_factor g2 = g / ac_component_norm_factor b2 = b / ac_component_norm_factor - r3 = math.floor(sign_pow(r2, 0.5) * 9.0 + 9.5) - g3 = math.floor(sign_pow(g2, 0.5) * 9.0 + 9.5) - b3 = math.floor(sign_pow(b2, 0.5) * 9.0 + 9.5) + r3 = math.floor(_sign_pow(r2, 0.5) * 9.0 + 9.5) + g3 = math.floor(_sign_pow(g2, 0.5) * 9.0 + 9.5) + b3 = math.floor(_sign_pow(b2, 0.5) * 9.0 + 9.5) ac_values.append( int(max(0.0, min(18.0, r3))) * 19 * 19 + int(max(0.0, min(18.0, g3))) * 19 + @@ -174,10 +174,10 @@ def blurhash_encode(image, components_x=4, components_y=4, linear=False): # Build final blurhash blurhash = "" - blurhash += base83_encode((components_x - 1) + (components_y - 1) * 9, 1) - blurhash += base83_encode(quant_max_ac_component, 1) - blurhash += base83_encode(dc_value, 4) + blurhash += _base83_encode((components_x - 1) + (components_y - 1) * 9, 1) + blurhash += _base83_encode(quant_max_ac_component, 1) + blurhash += _base83_encode(dc_value, 4) for ac_value in ac_values: - blurhash += base83_encode(ac_value, 2) + blurhash += _base83_encode(ac_value, 2) return blurhash diff --git a/bookmarks.py b/bookmarks.py index 07000fa88..a9bf0c457 100644 --- a/bookmarks.py +++ b/bookmarks.py @@ -107,7 +107,7 @@ def undoBookmarksCollectionEntry(recentPostsCache: {}, def bookmarkedByPerson(postJsonObject: {}, nickname: str, domain: str) -> bool: """Returns True if the given post is bookmarked by the given person """ - if noOfBookmarks(postJsonObject) == 0: + if _noOfBookmarks(postJsonObject) == 0: return False actorMatch = domain + '/users/' + nickname for item in postJsonObject['object']['bookmarks']['items']: @@ -116,7 +116,7 @@ def bookmarkedByPerson(postJsonObject: {}, nickname: str, domain: str) -> bool: return False -def noOfBookmarks(postJsonObject: {}) -> int: +def _noOfBookmarks(postJsonObject: {}) -> int: """Returns the number of bookmarks ona given post """ if not postJsonObject.get('object'): diff --git a/content.py b/content.py index e86b62ea0..431a2de08 100644 --- a/content.py +++ b/content.py @@ -33,7 +33,7 @@ def removeHtmlTag(htmlStr: str, tag: str) -> str: return htmlStr -def removeQuotesWithinQuotes(content: str) -> str: +def _removeQuotesWithinQuotes(content: str) -> str: """Removes any blockquote inside blockquote """ if '

' not in content: @@ -96,7 +96,7 @@ def htmlReplaceEmailQuote(content: str) -> str: else: lineStr = lineStr.replace('>', '
') newContent += '

' + lineStr + '

' - return removeQuotesWithinQuotes(newContent) + return _removeQuotesWithinQuotes(newContent) def htmlReplaceQuoteMarks(content: str) -> str: @@ -314,7 +314,7 @@ def replaceEmojiFromTags(content: str, tag: [], messageType: str) -> str: return content -def addMusicTag(content: str, tag: str) -> str: +def _addMusicTag(content: str, tag: str) -> str: """If a music link is found then ensure that the post is tagged appropriately """ @@ -416,8 +416,8 @@ def validHashTag(hashtag: str) -> bool: return False -def addHashTags(wordStr: str, httpPrefix: str, domain: str, - replaceHashTags: {}, postHashtags: {}) -> bool: +def _addHashTags(wordStr: str, httpPrefix: str, domain: str, + replaceHashTags: {}, postHashtags: {}) -> bool: """Detects hashtags and adds them to the replacements dict Also updates the hashtags list to be added to the post """ @@ -438,10 +438,10 @@ def addHashTags(wordStr: str, httpPrefix: str, domain: str, return True -def addEmoji(baseDir: str, wordStr: str, - httpPrefix: str, domain: str, - replaceEmoji: {}, postTags: {}, - emojiDict: {}) -> bool: +def _addEmoji(baseDir: str, wordStr: str, + httpPrefix: str, domain: str, + replaceEmoji: {}, postTags: {}, + emojiDict: {}) -> bool: """Detects Emoji and adds them to the replacements dict Also updates the tags list to be added to the post """ @@ -489,8 +489,8 @@ def tagExists(tagType: str, tagName: str, tags: {}) -> bool: return False -def addMention(wordStr: str, httpPrefix: str, following: str, - replaceMentions: {}, recipients: [], tags: {}) -> bool: +def _addMention(wordStr: str, httpPrefix: str, following: str, + replaceMentions: {}, recipients: [], tags: {}) -> bool: """Detects mentions and adds them to the replacements dict and recipients list """ @@ -672,7 +672,7 @@ def removeLongWords(content: str, maxWordLength: int, return content -def loadAutoTags(baseDir: str, nickname: str, domain: str) -> []: +def _loadAutoTags(baseDir: str, nickname: str, domain: str) -> []: """Loads automatic tags file and returns a list containing the lines of the file """ @@ -685,9 +685,9 @@ def loadAutoTags(baseDir: str, nickname: str, domain: str) -> []: return [] -def autoTag(baseDir: str, nickname: str, domain: str, - wordStr: str, autoTagList: [], - appendTags: []): +def _autoTag(baseDir: str, nickname: str, domain: str, + wordStr: str, autoTagList: [], + appendTags: []): """Generates a list of tags to be automatically appended to the content """ for tagRule in autoTagList: @@ -719,7 +719,7 @@ def addHtmlTags(baseDir: str, httpPrefix: str, maxWordLength = 40 content = content.replace('\r', '') content = content.replace('\n', ' --linebreak-- ') - content = addMusicTag(content, 'nowplaying') + content = _addMusicTag(content, 'nowplaying') contentSimplified = \ content.replace(',', ' ').replace(';', ' ').replace('- ', ' ') contentSimplified = contentSimplified.replace('. ', ' ').strip() @@ -760,7 +760,7 @@ def addHtmlTags(baseDir: str, httpPrefix: str, # extract mentions and tags from words longWordsList = [] prevWordStr = '' - autoTagsList = loadAutoTags(baseDir, nickname, domain) + autoTagsList = _loadAutoTags(baseDir, nickname, domain) appendTags = [] for wordStr in words: wordLen = len(wordStr) @@ -769,13 +769,13 @@ def addHtmlTags(baseDir: str, httpPrefix: str, longWordsList.append(wordStr) firstChar = wordStr[0] if firstChar == '@': - if addMention(wordStr, httpPrefix, following, - replaceMentions, recipients, hashtags): + if _addMention(wordStr, httpPrefix, following, + replaceMentions, recipients, hashtags): prevWordStr = '' continue elif firstChar == '#': - if addHashTags(wordStr, httpPrefix, originalDomain, - replaceHashTags, hashtags): + if _addHashTags(wordStr, httpPrefix, originalDomain, + replaceHashTags, hashtags): prevWordStr = '' continue elif ':' in wordStr: @@ -791,18 +791,18 @@ def addHtmlTags(baseDir: str, httpPrefix: str, emojiDict = loadJson(baseDir + '/emoji/emoji.json') # print('TAG: looking up emoji for :'+wordStr2+':') - addEmoji(baseDir, ':' + wordStr2 + ':', httpPrefix, - originalDomain, replaceEmoji, hashtags, - emojiDict) + _addEmoji(baseDir, ':' + wordStr2 + ':', httpPrefix, + originalDomain, replaceEmoji, hashtags, + emojiDict) else: - if autoTag(baseDir, nickname, domain, wordStr, - autoTagsList, appendTags): + if _autoTag(baseDir, nickname, domain, wordStr, + autoTagsList, appendTags): prevWordStr = '' continue if prevWordStr: - if autoTag(baseDir, nickname, domain, - prevWordStr + ' ' + wordStr, - autoTagsList, appendTags): + if _autoTag(baseDir, nickname, domain, + prevWordStr + ' ' + wordStr, + autoTagsList, appendTags): prevWordStr = '' continue prevWordStr = wordStr @@ -810,8 +810,8 @@ def addHtmlTags(baseDir: str, httpPrefix: str, # add any auto generated tags for appended in appendTags: content = content + ' ' + appended - addHashTags(appended, httpPrefix, originalDomain, - replaceHashTags, hashtags) + _addHashTags(appended, httpPrefix, originalDomain, + replaceHashTags, hashtags) # replace words with their html versions for wordStr, replaceStr in replaceMentions.items(): diff --git a/donate.py b/donate.py index ff8d64aab..1a4384ac7 100644 --- a/donate.py +++ b/donate.py @@ -7,7 +7,7 @@ __email__ = "bob@freedombone.net" __status__ = "Production" -def getDonationTypes() -> str: +def _getDonationTypes() -> str: return ('patreon', 'paypal', 'gofundme', 'liberapay', 'kickstarter', 'indiegogo', 'crowdsupply', 'subscribestar') @@ -18,7 +18,7 @@ def getDonationUrl(actorJson: {}) -> str: """ if not actorJson.get('attachment'): return '' - donationType = getDonationTypes() + donationType = _getDonationTypes() for propertyValue in actorJson['attachment']: if not propertyValue.get('name'): continue @@ -54,7 +54,7 @@ def setDonationUrl(actorJson: {}, donateUrl: str) -> None: if not actorJson.get('attachment'): actorJson['attachment'] = [] - donationType = getDonationTypes() + donationType = _getDonationTypes() donateName = None for paymentService in donationType: if paymentService in donateUrl: diff --git a/filters.py b/filters.py index dc726ff55..58c165564 100644 --- a/filters.py +++ b/filters.py @@ -79,7 +79,7 @@ def removeGlobalFilter(baseDir: str, words: str) -> bool: return False -def isTwitterPost(content: str) -> bool: +def _isTwitterPost(content: str) -> bool: """Returns true if the given post content is a retweet or twitter crosspost """ if '/twitter.' in content or '@twitter.' in content: @@ -89,7 +89,7 @@ def isTwitterPost(content: str) -> bool: return False -def isFilteredBase(filename: str, content: str) -> bool: +def _isFilteredBase(filename: str, content: str) -> bool: """Uses the given file containing filtered words to check the given content """ @@ -122,7 +122,7 @@ def isFiltered(baseDir: str, nickname: str, domain: str, content: str) -> bool: words must be present although not necessarily adjacent """ globalFiltersFilename = baseDir + '/accounts/filters.txt' - if isFilteredBase(globalFiltersFilename, content): + if _isFilteredBase(globalFiltersFilename, content): return True if not nickname or not domain: @@ -132,9 +132,9 @@ def isFiltered(baseDir: str, nickname: str, domain: str, content: str) -> bool: removeTwitter = baseDir + '/accounts/' + \ nickname + '@' + domain + '/.removeTwitter' if os.path.isfile(removeTwitter): - if isTwitterPost(content): + if _isTwitterPost(content): return True accountFiltersFilename = baseDir + '/accounts/' + \ nickname + '@' + domain + '/filters.txt' - return isFilteredBase(accountFiltersFilename, content) + return _isFilteredBase(accountFiltersFilename, content) diff --git a/follow.py b/follow.py index 2a765b15e..04a6a7db4 100644 --- a/follow.py +++ b/follow.py @@ -65,10 +65,10 @@ def createInitialLastSeen(baseDir: str, httpPrefix: str) -> None: break -def preApprovedFollower(baseDir: str, - nickname: str, domain: str, - approveHandle: str, - allowNewsFollowers: bool) -> bool: +def _preApprovedFollower(baseDir: str, + nickname: str, domain: str, + approveHandle: str, + allowNewsFollowers: bool) -> bool: """Is the given handle an already manually approved follower? """ # optionally allow the news account to be followed @@ -84,10 +84,10 @@ def preApprovedFollower(baseDir: str, return False -def removeFromFollowBase(baseDir: str, - nickname: str, domain: str, - acceptOrDenyHandle: str, followFile: str, - debug: bool) -> None: +def _removeFromFollowBase(baseDir: str, + nickname: str, domain: str, + acceptOrDenyHandle: str, followFile: str, + debug: bool) -> None: """Removes a handle from follow requests or rejects file """ handle = nickname + '@' + domain @@ -114,17 +114,17 @@ def removeFromFollowRequests(baseDir: str, denyHandle: str, debug: bool) -> None: """Removes a handle from follow requests """ - removeFromFollowBase(baseDir, nickname, domain, - denyHandle, 'followrequests', debug) + _removeFromFollowBase(baseDir, nickname, domain, + denyHandle, 'followrequests', debug) -def removeFromFollowRejects(baseDir: str, - nickname: str, domain: str, - acceptHandle: str, debug: bool) -> None: +def _removeFromFollowRejects(baseDir: str, + nickname: str, domain: str, + acceptHandle: str, debug: bool) -> None: """Removes a handle from follow rejects """ - removeFromFollowBase(baseDir, nickname, domain, - acceptHandle, 'followrejects', debug) + _removeFromFollowBase(baseDir, nickname, domain, + acceptHandle, 'followrejects', debug) def isFollowingActor(baseDir: str, @@ -179,8 +179,8 @@ def followerOfPerson(baseDir: str, nickname: str, domain: str, federationList, debug, 'followers.txt') -def isFollowerOfPerson(baseDir: str, nickname: str, domain: str, - followerNickname: str, followerDomain: str) -> bool: +def _isFollowerOfPerson(baseDir: str, nickname: str, domain: str, + followerNickname: str, followerDomain: str) -> bool: """is the given nickname a follower of followerNickname? """ if ':' in domain: @@ -291,9 +291,9 @@ def clearFollowers(baseDir: str, nickname: str, domain: str) -> None: clearFollows(baseDir, nickname, domain, 'followers.txt') -def getNoOfFollows(baseDir: str, nickname: str, domain: str, - authenticated: bool, - followFile='following.txt') -> int: +def _getNoOfFollows(baseDir: str, nickname: str, domain: str, + authenticated: bool, + followFile='following.txt') -> int: """Returns the number of follows or followers """ # only show number of followers to authenticated @@ -324,12 +324,12 @@ def getNoOfFollows(baseDir: str, nickname: str, domain: str, return ctr -def getNoOfFollowers(baseDir: str, - nickname: str, domain: str, authenticated: bool) -> int: +def _getNoOfFollowers(baseDir: str, + nickname: str, domain: str, authenticated: bool) -> int: """Returns the number of followers of the given person """ - return getNoOfFollows(baseDir, nickname, domain, - authenticated, 'followers.txt') + return _getNoOfFollows(baseDir, nickname, domain, + authenticated, 'followers.txt') def getFollowingFeed(baseDir: str, domain: str, port: int, path: str, @@ -382,7 +382,7 @@ def getFollowingFeed(baseDir: str, domain: str, port: int, path: str, httpPrefix + '://' + domain + '/users/' + \ nickname + '/' + followFile totalStr = \ - getNoOfFollows(baseDir, nickname, domain, authenticated) + _getNoOfFollows(baseDir, nickname, domain, authenticated) following = { '@context': 'https://www.w3.org/ns/activitystreams', 'first': firstStr, @@ -463,15 +463,15 @@ def getFollowingFeed(baseDir: str, domain: str, port: int, path: str, return following -def followApprovalRequired(baseDir: str, nicknameToFollow: str, - domainToFollow: str, debug: bool, - followRequestHandle: str, - allowNewsFollowers: bool) -> bool: +def _followApprovalRequired(baseDir: str, nicknameToFollow: str, + domainToFollow: str, debug: bool, + followRequestHandle: str, + allowNewsFollowers: bool) -> bool: """ Returns the policy for follower approvals """ # has this handle already been manually approved? - if preApprovedFollower(baseDir, nicknameToFollow, domainToFollow, - followRequestHandle, allowNewsFollowers): + if _preApprovedFollower(baseDir, nicknameToFollow, domainToFollow, + followRequestHandle, allowNewsFollowers): return False manuallyApproveFollows = False @@ -494,10 +494,10 @@ def followApprovalRequired(baseDir: str, nicknameToFollow: str, return manuallyApproveFollows -def noOfFollowRequests(baseDir: str, - nicknameToFollow: str, domainToFollow: str, - nickname: str, domain: str, fromPort: int, - followType: str) -> int: +def _noOfFollowRequests(baseDir: str, + nicknameToFollow: str, domainToFollow: str, + nickname: str, domain: str, fromPort: int, + followType: str) -> int: """Returns the current number of follow requests """ accountsDir = baseDir + '/accounts/' + \ @@ -521,11 +521,11 @@ def noOfFollowRequests(baseDir: str, return ctr -def storeFollowRequest(baseDir: str, - nicknameToFollow: str, domainToFollow: str, port: int, - nickname: str, domain: str, fromPort: int, - followJson: {}, - debug: bool, personUrl: str) -> bool: +def _storeFollowRequest(baseDir: str, + nicknameToFollow: str, domainToFollow: str, port: int, + nickname: str, domain: str, fromPort: int, + followJson: {}, + debug: bool, personUrl: str) -> bool: """Stores the follow request for later use """ accountsDir = baseDir + '/accounts/' + \ @@ -668,9 +668,9 @@ def receiveFollowRequest(session, baseDir: str, httpPrefix: str, nicknameToFollow) return True if maxFollowers > 0: - if getNoOfFollowers(baseDir, - nicknameToFollow, domainToFollow, - True) > maxFollowers: + if _getNoOfFollowers(baseDir, + nicknameToFollow, domainToFollow, + True) > maxFollowers: print('WARN: ' + nicknameToFollow + ' has reached their maximum number of followers') return True @@ -682,9 +682,9 @@ def receiveFollowRequest(session, baseDir: str, httpPrefix: str, baseDir + '/accounts/' + handleToFollow) return True - if isFollowerOfPerson(baseDir, - nicknameToFollow, domainToFollowFull, - nickname, domainFull): + if _isFollowerOfPerson(baseDir, + nicknameToFollow, domainToFollowFull, + nickname, domainFull): if debug: print('DEBUG: ' + nickname + '@' + domain + ' is already a follower of ' + @@ -693,37 +693,37 @@ def receiveFollowRequest(session, baseDir: str, httpPrefix: str, # what is the followers policy? approveHandle = nickname + '@' + domainFull - if followApprovalRequired(baseDir, nicknameToFollow, - domainToFollow, debug, approveHandle, - allowNewsFollowers): + if _followApprovalRequired(baseDir, nicknameToFollow, + domainToFollow, debug, approveHandle, + allowNewsFollowers): print('Follow approval is required') if domain.endswith('.onion'): - if noOfFollowRequests(baseDir, - nicknameToFollow, domainToFollow, - nickname, domain, fromPort, - 'onion') > 5: + if _noOfFollowRequests(baseDir, + nicknameToFollow, domainToFollow, + nickname, domain, fromPort, + 'onion') > 5: print('Too many follow requests from onion addresses') return False elif domain.endswith('.i2p'): - if noOfFollowRequests(baseDir, - nicknameToFollow, domainToFollow, - nickname, domain, fromPort, - 'i2p') > 5: + if _noOfFollowRequests(baseDir, + nicknameToFollow, domainToFollow, + nickname, domain, fromPort, + 'i2p') > 5: print('Too many follow requests from i2p addresses') return False else: - if noOfFollowRequests(baseDir, - nicknameToFollow, domainToFollow, - nickname, domain, fromPort, - '') > 10: + if _noOfFollowRequests(baseDir, + nicknameToFollow, domainToFollow, + nickname, domain, fromPort, + '') > 10: print('Too many follow requests') return False print('Storing follow request for approval') - return storeFollowRequest(baseDir, - nicknameToFollow, domainToFollow, port, - nickname, domain, fromPort, - messageJson, debug, messageJson['actor']) + return _storeFollowRequest(baseDir, + nicknameToFollow, domainToFollow, port, + nickname, domain, fromPort, + messageJson, debug, messageJson['actor']) else: print('Follow request does not require approval') # update the followers @@ -920,15 +920,15 @@ def sendFollowRequest(session, baseDir: str, 'object': followedId } - if followApprovalRequired(baseDir, nickname, domain, debug, - followHandle, allowNewsFollowers): + if _followApprovalRequired(baseDir, nickname, domain, debug, + followHandle, allowNewsFollowers): # Remove any follow requests rejected for the account being followed. # It's assumed that if you are following someone then you are # ok with them following back. If this isn't the case then a rejected # follow request will block them again. - removeFromFollowRejects(baseDir, - nickname, domain, - followHandle, debug) + _removeFromFollowRejects(baseDir, + nickname, domain, + followHandle, debug) sendSignedJson(newFollowJson, session, baseDir, nickname, domain, port, followNickname, followDomain, followPort, diff --git a/followingCalendar.py b/followingCalendar.py index 2281fda63..45707c26f 100644 --- a/followingCalendar.py +++ b/followingCalendar.py @@ -34,10 +34,10 @@ def receivingCalendarEvents(baseDir: str, nickname: str, domain: str, return handle + '\n' in open(calendarFilename).read() -def receiveCalendarEvents(baseDir: str, nickname: str, domain: str, - followingNickname: str, - followingDomain: str, - add: bool) -> None: +def _receiveCalendarEvents(baseDir: str, nickname: str, domain: str, + followingNickname: str, + followingDomain: str, + add: bool) -> None: """Adds or removes a handle from the following.txt list into a list indicating whether to receive calendar events from that account """ @@ -100,12 +100,12 @@ def receiveCalendarEvents(baseDir: str, nickname: str, domain: str, def addPersonToCalendar(baseDir: str, nickname: str, domain: str, followingNickname: str, followingDomain: str) -> None: - receiveCalendarEvents(baseDir, nickname, domain, - followingNickname, followingDomain, True) + _receiveCalendarEvents(baseDir, nickname, domain, + followingNickname, followingDomain, True) def removePersonFromCalendar(baseDir: str, nickname: str, domain: str, followingNickname: str, followingDomain: str) -> None: - receiveCalendarEvents(baseDir, nickname, domain, - followingNickname, followingDomain, False) + _receiveCalendarEvents(baseDir, nickname, domain, + followingNickname, followingDomain, False) diff --git a/git.py b/git.py index dda0f31a0..af2b935c3 100644 --- a/git.py +++ b/git.py @@ -10,7 +10,7 @@ import os import html -def gitFormatContent(content: str) -> str: +def _gitFormatContent(content: str) -> str: """ replace html formatting, so that it's more like the original patch file """ @@ -22,8 +22,8 @@ def gitFormatContent(content: str) -> str: return patchStr -def getGitProjectName(baseDir: str, nickname: str, domain: str, - subject: str) -> str: +def _getGitProjectName(baseDir: str, nickname: str, domain: str, + subject: str) -> str: """Returns the project name for a git patch The project name should be contained within the subject line and should match against a list of projects which the account @@ -71,13 +71,13 @@ def isGitPatch(baseDir: str, nickname: str, domain: str, return False if checkProjectName: projectName = \ - getGitProjectName(baseDir, nickname, domain, subject) + _getGitProjectName(baseDir, nickname, domain, subject) if not projectName: return False return True -def getGitHash(patchStr: str) -> str: +def _getGitHash(patchStr: str) -> str: """Returns the commit hash from a given patch """ patchLines = patchStr.split('\n') @@ -91,7 +91,7 @@ def getGitHash(patchStr: str) -> str: return None -def getPatchDescription(patchStr: str) -> str: +def _getPatchDescription(patchStr: str) -> str: """Returns the description from a given patch """ patchLines = patchStr.split('\n') @@ -134,8 +134,8 @@ def convertPostToPatch(baseDir: str, nickname: str, domain: str, postJsonObject['object']['content'], False): return False - patchStr = gitFormatContent(postJsonObject['object']['content']) - commitHash = getGitHash(patchStr) + patchStr = _gitFormatContent(postJsonObject['object']['content']) + commitHash = _getGitHash(patchStr) if not commitHash: return False postJsonObject['object']['type'] = 'Patch' @@ -146,7 +146,7 @@ def convertPostToPatch(baseDir: str, nickname: str, domain: str, postJsonObject['object']['hash'] = commitHash postJsonObject['object']['description'] = { "mediaType": "text/plain", - "content": getPatchDescription(patchStr) + "content": _getPatchDescription(patchStr) } # remove content map if postJsonObject['object'].get('contentMap'): @@ -155,7 +155,7 @@ def convertPostToPatch(baseDir: str, nickname: str, domain: str, return True -def gitAddFromHandle(patchStr: str, handle: str) -> str: +def _gitAddFromHandle(patchStr: str, handle: str) -> str: """Adds the activitypub handle of the sender to the patch """ fromStr = 'AP-signed-off-by: ' @@ -181,7 +181,7 @@ def receiveGitPatch(baseDir: str, nickname: str, domain: str, messageType, subject, content): return False - patchStr = gitFormatContent(content) + patchStr = _gitFormatContent(content) patchLines = patchStr.split('\n') patchFilename = None @@ -197,7 +197,7 @@ def receiveGitPatch(baseDir: str, nickname: str, domain: str, patchSubject = patchSubject.replace('[PATCH]', '').strip() patchSubject = patchSubject.replace(' ', '_') projectName = \ - getGitProjectName(baseDir, nickname, domain, subject) + _getGitProjectName(baseDir, nickname, domain, subject) if not os.path.isdir(patchesDir): os.mkdir(patchesDir) projectDir = patchesDir + '/' + projectName @@ -209,7 +209,7 @@ def receiveGitPatch(baseDir: str, nickname: str, domain: str, if not patchFilename: return False patchStr = \ - gitAddFromHandle(patchStr, '@' + fromNickname + '@' + fromDomain) + _gitAddFromHandle(patchStr, '@' + fromNickname + '@' + fromDomain) with open(patchFilename, 'w+') as patchFile: patchFile.write(patchStr) patchNotifyFilename = \ diff --git a/happening.py b/happening.py index 6f1d2b1e7..137adb138 100644 --- a/happening.py +++ b/happening.py @@ -17,7 +17,7 @@ from utils import daysInMonth from utils import mergeDicts -def validUuid(testUuid: str, version=4): +def _validUuid(testUuid: str, version=4): """Check if uuid_to_test is a valid UUID """ try: @@ -28,7 +28,7 @@ def validUuid(testUuid: str, version=4): return str(uuid_obj) == testUuid -def removeEventFromTimeline(eventId: str, tlEventsFilename: str) -> None: +def _removeEventFromTimeline(eventId: str, tlEventsFilename: str) -> None: """Removes the given event Id from the timeline """ if eventId + '\n' not in open(tlEventsFilename).read(): @@ -71,7 +71,7 @@ def saveEventPost(baseDir: str, handle: str, postId: str, if eventJson.get('name') and eventJson.get('actor') and \ eventJson.get('uuid') and eventJson.get('content'): - if not validUuid(eventJson['uuid']): + if not _validUuid(eventJson['uuid']): return False print('Mobilizon type event') # if this is a full description of an event then save it @@ -92,7 +92,7 @@ def saveEventPost(baseDir: str, handle: str, postId: str, tlEventsFilename = baseDir + '/accounts/' + handle + '/events.txt' if os.path.isfile(tlEventsFilename): - removeEventFromTimeline(eventId, tlEventsFilename) + _removeEventFromTimeline(eventId, tlEventsFilename) try: with open(tlEventsFilename, 'r+') as tlEventsFile: content = tlEventsFile.read() @@ -146,7 +146,7 @@ def saveEventPost(baseDir: str, handle: str, postId: str, return True -def isHappeningEvent(tag: {}) -> bool: +def _isHappeningEvent(tag: {}) -> bool: """Is this tag an Event or Place ActivityStreams type? """ if not tag.get('type'): @@ -156,7 +156,7 @@ def isHappeningEvent(tag: {}) -> bool: return True -def isHappeningPost(postJsonObject: {}) -> bool: +def _isHappeningPost(postJsonObject: {}) -> bool: """Is this a post with tags? """ if not postJsonObject: @@ -208,13 +208,13 @@ def getTodaysEvents(baseDir: str, nickname: str, domain: str, continue postJsonObject = loadJson(postFilename) - if not isHappeningPost(postJsonObject): + if not _isHappeningPost(postJsonObject): continue postEvent = [] dayOfMonth = None for tag in postJsonObject['object']['tag']: - if not isHappeningEvent(tag): + if not _isHappeningEvent(tag): continue # this tag is an event or a place if tag['type'] == 'Event': @@ -275,11 +275,11 @@ def todaysEventsCheck(baseDir: str, nickname: str, domain: str) -> bool: continue postJsonObject = loadJson(postFilename) - if not isHappeningPost(postJsonObject): + if not _isHappeningPost(postJsonObject): continue for tag in postJsonObject['object']['tag']: - if not isHappeningEvent(tag): + if not _isHappeningEvent(tag): continue # this tag is an event or a place if tag['type'] != 'Event': @@ -322,11 +322,11 @@ def thisWeeksEventsCheck(baseDir: str, nickname: str, domain: str) -> bool: continue postJsonObject = loadJson(postFilename) - if not isHappeningPost(postJsonObject): + if not _isHappeningPost(postJsonObject): continue for tag in postJsonObject['object']['tag']: - if not isHappeningEvent(tag): + if not _isHappeningEvent(tag): continue # this tag is an event or a place if tag['type'] != 'Event': @@ -377,14 +377,14 @@ def getThisWeeksEvents(baseDir: str, nickname: str, domain: str) -> {}: continue postJsonObject = loadJson(postFilename) - if not isHappeningPost(postJsonObject): + if not _isHappeningPost(postJsonObject): continue postEvent = [] dayOfMonth = None weekDayIndex = None for tag in postJsonObject['object']['tag']: - if not isHappeningEvent(tag): + if not _isHappeningEvent(tag): continue # this tag is an event or a place if tag['type'] == 'Event': @@ -462,13 +462,13 @@ def getCalendarEvents(baseDir: str, nickname: str, domain: str, continue postJsonObject = loadJson(postFilename) - if not isHappeningPost(postJsonObject): + if not _isHappeningPost(postJsonObject): continue postEvent = [] dayOfMonth = None for tag in postJsonObject['object']['tag']: - if not isHappeningEvent(tag): + if not _isHappeningEvent(tag): continue # this tag is an event or a place if tag['type'] == 'Event': diff --git a/httpsig.py b/httpsig.py index 77873c801..0df2850dc 100644 --- a/httpsig.py +++ b/httpsig.py @@ -135,7 +135,7 @@ def createSignedHeader(privateKeyPem: str, nickname: str, return headers -def verifyRecentSignature(signedDateStr: str) -> bool: +def _verifyRecentSignature(signedDateStr: str) -> bool: """Checks whether the given time taken from the header is within 12 hours of the current time """ @@ -219,7 +219,7 @@ def verifyPostHeaders(httpPrefix: str, publicKeyPem: str, headers: dict, else: if headers.get(signedHeader): if signedHeader == 'date': - if not verifyRecentSignature(headers[signedHeader]): + if not _verifyRecentSignature(headers[signedHeader]): if debug: print('DEBUG: ' + 'verifyPostHeaders date is not recent ' + @@ -230,7 +230,7 @@ def verifyPostHeaders(httpPrefix: str, publicKeyPem: str, headers: dict, else: signedHeaderCap = signedHeader.capitalize() if signedHeaderCap == 'Date': - if not verifyRecentSignature(headers[signedHeaderCap]): + if not _verifyRecentSignature(headers[signedHeaderCap]): if debug: print('DEBUG: ' + 'verifyPostHeaders date is not recent ' + diff --git a/inbox.py b/inbox.py index 7be1f1a4d..70073d718 100644 --- a/inbox.py +++ b/inbox.py @@ -138,14 +138,14 @@ def storeHashTags(baseDir: str, nickname: str, postJsonObject: {}) -> None: setHashtagCategory(baseDir, tagName, categoryStr) -def inboxStorePostToHtmlCache(recentPostsCache: {}, maxRecentPosts: int, - translate: {}, - baseDir: str, httpPrefix: str, - session, cachedWebfingers: {}, personCache: {}, - nickname: str, domain: str, port: int, - postJsonObject: {}, - allowDeletion: bool, boxname: str, - showPublishedDateOnly: bool) -> None: +def _inboxStorePostToHtmlCache(recentPostsCache: {}, maxRecentPosts: int, + translate: {}, + baseDir: str, httpPrefix: str, + session, cachedWebfingers: {}, personCache: {}, + nickname: str, domain: str, port: int, + postJsonObject: {}, + allowDeletion: bool, boxname: str, + showPublishedDateOnly: bool) -> None: """Converts the json post into html and stores it in a cache This enables the post to be quickly displayed later """ @@ -451,10 +451,10 @@ def savePostToInboxQueue(baseDir: str, httpPrefix: str, return filename -def inboxPostRecipientsAdd(baseDir: str, httpPrefix: str, toList: [], - recipientsDict: {}, - domainMatch: str, domain: str, - actor: str, debug: bool) -> bool: +def _inboxPostRecipientsAdd(baseDir: str, httpPrefix: str, toList: [], + recipientsDict: {}, + domainMatch: str, domain: str, + actor: str, debug: bool) -> bool: """Given a list of post recipients (toList) from 'to' or 'cc' parameters populate a recipientsDict with the handle for each """ @@ -485,9 +485,9 @@ def inboxPostRecipientsAdd(baseDir: str, httpPrefix: str, toList: [], return followerRecipients, recipientsDict -def inboxPostRecipients(baseDir: str, postJsonObject: {}, - httpPrefix: str, domain: str, port: int, - debug: bool) -> ([], []): +def _inboxPostRecipients(baseDir: str, postJsonObject: {}, + httpPrefix: str, domain: str, port: int, + debug: bool) -> ([], []): """Returns dictionaries containing the recipients of the given post The shared dictionary contains followers """ @@ -520,11 +520,11 @@ def inboxPostRecipients(baseDir: str, postJsonObject: {}, if debug: print('DEBUG: resolving "to"') includesFollowers, recipientsDict = \ - inboxPostRecipientsAdd(baseDir, httpPrefix, - recipientsList, - recipientsDict, - domainMatch, domainBase, - actor, debug) + _inboxPostRecipientsAdd(baseDir, httpPrefix, + recipientsList, + recipientsDict, + domainMatch, domainBase, + actor, debug) if includesFollowers: followerRecipients = True else: @@ -537,11 +537,11 @@ def inboxPostRecipients(baseDir: str, postJsonObject: {}, else: recipientsList = [postJsonObject['object']['cc']] includesFollowers, recipientsDict = \ - inboxPostRecipientsAdd(baseDir, httpPrefix, - recipientsList, - recipientsDict, - domainMatch, domainBase, - actor, debug) + _inboxPostRecipientsAdd(baseDir, httpPrefix, + recipientsList, + recipientsDict, + domainMatch, domainBase, + actor, debug) if includesFollowers: followerRecipients = True else: @@ -562,11 +562,11 @@ def inboxPostRecipients(baseDir: str, postJsonObject: {}, else: recipientsList = [postJsonObject['to']] includesFollowers, recipientsDict = \ - inboxPostRecipientsAdd(baseDir, httpPrefix, - recipientsList, - recipientsDict, - domainMatch, domainBase, - actor, debug) + _inboxPostRecipientsAdd(baseDir, httpPrefix, + recipientsList, + recipientsDict, + domainMatch, domainBase, + actor, debug) if includesFollowers: followerRecipients = True @@ -576,11 +576,11 @@ def inboxPostRecipients(baseDir: str, postJsonObject: {}, else: recipientsList = [postJsonObject['cc']] includesFollowers, recipientsDict = \ - inboxPostRecipientsAdd(baseDir, httpPrefix, - recipientsList, - recipientsDict, - domainMatch, domainBase, - actor, debug) + _inboxPostRecipientsAdd(baseDir, httpPrefix, + recipientsList, + recipientsDict, + domainMatch, domainBase, + actor, debug) if includesFollowers: followerRecipients = True @@ -596,10 +596,10 @@ def inboxPostRecipients(baseDir: str, postJsonObject: {}, return recipientsDict, recipientsDictFollowers -def receiveUndoFollow(session, baseDir: str, httpPrefix: str, - port: int, messageJson: {}, - federationList: [], - debug: bool) -> bool: +def _receiveUndoFollow(session, baseDir: str, httpPrefix: str, + port: int, messageJson: {}, + federationList: [], + debug: bool) -> bool: if not messageJson['object'].get('actor'): if debug: print('DEBUG: follow request has no actor within object') @@ -653,11 +653,11 @@ def receiveUndoFollow(session, baseDir: str, httpPrefix: str, return False -def receiveUndo(session, baseDir: str, httpPrefix: str, - port: int, sendThreads: [], postLog: [], - cachedWebfingers: {}, personCache: {}, - messageJson: {}, federationList: [], - debug: bool) -> bool: +def _receiveUndo(session, baseDir: str, httpPrefix: str, + port: int, sendThreads: [], postLog: [], + cachedWebfingers: {}, personCache: {}, + messageJson: {}, federationList: [], + debug: bool) -> bool: """Receives an undo request within the POST section of HTTPServer """ if not messageJson['type'].startswith('Undo'): @@ -698,17 +698,17 @@ def receiveUndo(session, baseDir: str, httpPrefix: str, ' object within object is not a string') return False if messageJson['object']['type'] == 'Follow': - return receiveUndoFollow(session, baseDir, httpPrefix, - port, messageJson, - federationList, debug) + return _receiveUndoFollow(session, baseDir, httpPrefix, + port, messageJson, + federationList, debug) return False -def receiveEventPost(recentPostsCache: {}, session, baseDir: str, - httpPrefix: str, domain: str, port: int, - sendThreads: [], postLog: [], cachedWebfingers: {}, - personCache: {}, messageJson: {}, federationList: [], - nickname: str, debug: bool) -> bool: +def _receiveEventPost(recentPostsCache: {}, session, baseDir: str, + httpPrefix: str, domain: str, port: int, + sendThreads: [], postLog: [], cachedWebfingers: {}, + personCache: {}, messageJson: {}, federationList: [], + nickname: str, debug: bool) -> bool: """Receive a mobilizon-type event activity See https://framagit.org/framasoft/mobilizon/-/blob/ master/lib/federation/activity_stream/converter/event.ex @@ -723,11 +723,12 @@ def receiveEventPost(recentPostsCache: {}, session, baseDir: str, saveEventPost(baseDir, handle, postId, messageJson['object']) -def personReceiveUpdate(baseDir: str, - domain: str, port: int, - updateNickname: str, updateDomain: str, - updatePort: int, - personJson: {}, personCache: {}, debug: bool) -> bool: +def _personReceiveUpdate(baseDir: str, + domain: str, port: int, + updateNickname: str, updateDomain: str, + updatePort: int, + personJson: {}, personCache: {}, + debug: bool) -> bool: """Changes an actor. eg: avatar or display name change """ print('Receiving actor update for ' + personJson['url'] + @@ -795,8 +796,9 @@ def personReceiveUpdate(baseDir: str, return True -def receiveUpdateToQuestion(recentPostsCache: {}, messageJson: {}, - baseDir: str, nickname: str, domain: str) -> None: +def _receiveUpdateToQuestion(recentPostsCache: {}, messageJson: {}, + baseDir: str, + nickname: str, domain: str) -> None: """Updating a question as new votes arrive """ # message url of the question @@ -832,11 +834,11 @@ def receiveUpdateToQuestion(recentPostsCache: {}, messageJson: {}, removePostFromCache(messageJson, recentPostsCache) -def receiveUpdate(recentPostsCache: {}, session, baseDir: str, - httpPrefix: str, domain: str, port: int, - sendThreads: [], postLog: [], cachedWebfingers: {}, - personCache: {}, messageJson: {}, federationList: [], - nickname: str, debug: bool) -> bool: +def _receiveUpdate(recentPostsCache: {}, session, baseDir: str, + httpPrefix: str, domain: str, port: int, + sendThreads: [], postLog: [], cachedWebfingers: {}, + personCache: {}, messageJson: {}, federationList: [], + nickname: str, debug: bool) -> bool: """Receives an Update activity within the POST section of HTTPServer """ if messageJson['type'] != 'Update': @@ -867,8 +869,8 @@ def receiveUpdate(recentPostsCache: {}, session, baseDir: str, return False if messageJson['object']['type'] == 'Question': - receiveUpdateToQuestion(recentPostsCache, messageJson, - baseDir, nickname, domain) + _receiveUpdateToQuestion(recentPostsCache, messageJson, + baseDir, nickname, domain) if debug: print('DEBUG: Question update was received') return True @@ -880,10 +882,10 @@ def receiveUpdate(recentPostsCache: {}, session, baseDir: str, if updateNickname: updateDomain, updatePort = \ getDomainFromActor(messageJson['id']) - if personReceiveUpdate(baseDir, domain, port, - updateNickname, updateDomain, - updatePort, messageJson, - personCache, debug): + if _personReceiveUpdate(baseDir, domain, port, + updateNickname, updateDomain, + updatePort, messageJson, + personCache, debug): if debug: print('DEBUG: ' + 'Unwrapped profile update was received for ' + @@ -901,12 +903,12 @@ def receiveUpdate(recentPostsCache: {}, session, baseDir: str, if updateNickname: updateDomain, updatePort = \ getDomainFromActor(messageJson['actor']) - if personReceiveUpdate(baseDir, - domain, port, - updateNickname, updateDomain, - updatePort, - messageJson['object'], - personCache, debug): + if _personReceiveUpdate(baseDir, + domain, port, + updateNickname, updateDomain, + updatePort, + messageJson['object'], + personCache, debug): if debug: print('DEBUG: Profile update was received for ' + messageJson['object']['url']) @@ -914,13 +916,13 @@ def receiveUpdate(recentPostsCache: {}, session, baseDir: str, return False -def receiveLike(recentPostsCache: {}, - session, handle: str, isGroup: bool, baseDir: str, - httpPrefix: str, domain: str, port: int, - onionDomain: str, - sendThreads: [], postLog: [], cachedWebfingers: {}, - personCache: {}, messageJson: {}, federationList: [], - debug: bool) -> bool: +def _receiveLike(recentPostsCache: {}, + session, handle: str, isGroup: bool, baseDir: str, + httpPrefix: str, domain: str, port: int, + onionDomain: str, + sendThreads: [], postLog: [], cachedWebfingers: {}, + personCache: {}, messageJson: {}, federationList: [], + debug: bool) -> bool: """Receives a Like activity within the POST section of HTTPServer """ if messageJson['type'] != 'Like': @@ -968,25 +970,25 @@ def receiveLike(recentPostsCache: {}, if debug: print('DEBUG: liked post found in inbox') - if not alreadyLiked(baseDir, - handle.split('@')[0], - handle.split('@')[1], - messageJson['object'], - messageJson['actor']): + if not _alreadyLiked(baseDir, + handle.split('@')[0], + handle.split('@')[1], + messageJson['object'], + messageJson['actor']): updateLikesCollection(recentPostsCache, baseDir, postFilename, messageJson['object'], messageJson['actor'], domain, debug) - likeNotify(baseDir, domain, onionDomain, handle, - messageJson['actor'], messageJson['object']) + _likeNotify(baseDir, domain, onionDomain, handle, + messageJson['actor'], messageJson['object']) return True -def receiveUndoLike(recentPostsCache: {}, - session, handle: str, isGroup: bool, baseDir: str, - httpPrefix: str, domain: str, port: int, - sendThreads: [], postLog: [], cachedWebfingers: {}, - personCache: {}, messageJson: {}, federationList: [], - debug: bool) -> bool: +def _receiveUndoLike(recentPostsCache: {}, + session, handle: str, isGroup: bool, baseDir: str, + httpPrefix: str, domain: str, port: int, + sendThreads: [], postLog: [], cachedWebfingers: {}, + personCache: {}, messageJson: {}, federationList: [], + debug: bool) -> bool: """Receives an undo like activity within the POST section of HTTPServer """ if messageJson['type'] != 'Undo': @@ -1042,12 +1044,12 @@ def receiveUndoLike(recentPostsCache: {}, return True -def receiveBookmark(recentPostsCache: {}, - session, handle: str, isGroup: bool, baseDir: str, - httpPrefix: str, domain: str, port: int, - sendThreads: [], postLog: [], cachedWebfingers: {}, - personCache: {}, messageJson: {}, federationList: [], - debug: bool) -> bool: +def _receiveBookmark(recentPostsCache: {}, + session, handle: str, isGroup: bool, baseDir: str, + httpPrefix: str, domain: str, port: int, + sendThreads: [], postLog: [], cachedWebfingers: {}, + personCache: {}, messageJson: {}, federationList: [], + debug: bool) -> bool: """Receives a bookmark activity within the POST section of HTTPServer """ if messageJson['type'] != 'Bookmark': @@ -1108,12 +1110,12 @@ def receiveBookmark(recentPostsCache: {}, return True -def receiveUndoBookmark(recentPostsCache: {}, - session, handle: str, isGroup: bool, baseDir: str, - httpPrefix: str, domain: str, port: int, - sendThreads: [], postLog: [], cachedWebfingers: {}, - personCache: {}, messageJson: {}, federationList: [], - debug: bool) -> bool: +def _receiveUndoBookmark(recentPostsCache: {}, + session, handle: str, isGroup: bool, baseDir: str, + httpPrefix: str, domain: str, port: int, + sendThreads: [], postLog: [], cachedWebfingers: {}, + personCache: {}, messageJson: {}, federationList: [], + debug: bool) -> bool: """Receives an undo bookmark activity within the POST section of HTTPServer """ if messageJson['type'] != 'Undo': @@ -1177,12 +1179,12 @@ def receiveUndoBookmark(recentPostsCache: {}, return True -def receiveDelete(session, handle: str, isGroup: bool, baseDir: str, - httpPrefix: str, domain: str, port: int, - sendThreads: [], postLog: [], cachedWebfingers: {}, - personCache: {}, messageJson: {}, federationList: [], - debug: bool, allowDeletion: bool, - recentPostsCache: {}) -> bool: +def _receiveDelete(session, handle: str, isGroup: bool, baseDir: str, + httpPrefix: str, domain: str, port: int, + sendThreads: [], postLog: [], cachedWebfingers: {}, + personCache: {}, messageJson: {}, federationList: [], + debug: bool, allowDeletion: bool, + recentPostsCache: {}) -> bool: """Receives a Delete activity within the POST section of HTTPServer """ if messageJson['type'] != 'Delete': @@ -1263,13 +1265,14 @@ def receiveDelete(session, handle: str, isGroup: bool, baseDir: str, return True -def receiveAnnounce(recentPostsCache: {}, - session, handle: str, isGroup: bool, baseDir: str, - httpPrefix: str, domain: str, onionDomain: str, port: int, - sendThreads: [], postLog: [], cachedWebfingers: {}, - personCache: {}, messageJson: {}, federationList: [], - debug: bool, translate: {}, - YTReplacementDomain: str) -> bool: +def _receiveAnnounce(recentPostsCache: {}, + session, handle: str, isGroup: bool, baseDir: str, + httpPrefix: str, + domain: str, onionDomain: str, port: int, + sendThreads: [], postLog: [], cachedWebfingers: {}, + personCache: {}, messageJson: {}, federationList: [], + debug: bool, translate: {}, + YTReplacementDomain: str) -> bool: """Receives an announce activity within the POST section of HTTPServer """ if messageJson['type'] != 'Announce': @@ -1410,12 +1413,12 @@ def receiveAnnounce(recentPostsCache: {}, return True -def receiveUndoAnnounce(recentPostsCache: {}, - session, handle: str, isGroup: bool, baseDir: str, - httpPrefix: str, domain: str, port: int, - sendThreads: [], postLog: [], cachedWebfingers: {}, - personCache: {}, messageJson: {}, federationList: [], - debug: bool) -> bool: +def _receiveUndoAnnounce(recentPostsCache: {}, + session, handle: str, isGroup: bool, baseDir: str, + httpPrefix: str, domain: str, port: int, + sendThreads: [], postLog: [], cachedWebfingers: {}, + personCache: {}, messageJson: {}, federationList: [], + debug: bool) -> bool: """Receives an undo announce activity within the POST section of HTTPServer """ if messageJson['type'] != 'Undo': @@ -1482,7 +1485,7 @@ def jsonPostAllowsComments(postJsonObject: {}) -> bool: return True -def postAllowsComments(postFilename: str) -> bool: +def _postAllowsComments(postFilename: str) -> bool: """Returns true if the given post allows comments/replies """ postJsonObject = loadJson(postFilename) @@ -1533,7 +1536,7 @@ def populateReplies(baseDir: str, httpPrefix: str, domain: str, if debug: print('DEBUG: post may have expired - ' + replyTo) return False - if not postAllowsComments(postFilename): + if not _postAllowsComments(postFilename): if debug: print('DEBUG: post does not allow comments - ' + replyTo) return False @@ -1555,21 +1558,21 @@ def populateReplies(baseDir: str, httpPrefix: str, domain: str, return True -def estimateNumberOfMentions(content: str) -> int: +def _estimateNumberOfMentions(content: str) -> int: """Returns a rough estimate of the number of mentions """ return int(content.count('@') / 2) -def estimateNumberOfEmoji(content: str) -> int: +def _estimateNumberOfEmoji(content: str) -> int: """Returns a rough estimate of the number of emoji """ return int(content.count(':') / 2) -def validPostContent(baseDir: str, nickname: str, domain: str, - messageJson: {}, maxMentions: int, maxEmoji: int, - allowLocalNetworkAccess: bool) -> bool: +def _validPostContent(baseDir: str, nickname: str, domain: str, + messageJson: {}, maxMentions: int, maxEmoji: int, + allowLocalNetworkAccess: bool) -> bool: """Is the content of a received post valid? Check for bad html Check for hellthreads @@ -1615,14 +1618,14 @@ def validPostContent(baseDir: str, nickname: str, domain: str, return False # check (rough) number of mentions - mentionsEst = estimateNumberOfMentions(messageJson['object']['content']) + mentionsEst = _estimateNumberOfMentions(messageJson['object']['content']) if mentionsEst > maxMentions: if messageJson['object'].get('id'): print('REJECT HELLTHREAD: ' + messageJson['object']['id']) print('REJECT HELLTHREAD: Too many mentions in post - ' + messageJson['object']['content']) return False - if estimateNumberOfEmoji(messageJson['object']['content']) > maxEmoji: + if _estimateNumberOfEmoji(messageJson['object']['content']) > maxEmoji: if messageJson['object'].get('id'): print('REJECT EMOJI OVERLOAD: ' + messageJson['object']['id']) print('REJECT EMOJI OVERLOAD: Too many emoji in post - ' + @@ -1650,7 +1653,7 @@ def validPostContent(baseDir: str, nickname: str, domain: str, postPostFilename = locatePost(baseDir, nickname, domain, originalPostId) if postPostFilename: - if not postAllowsComments(postPostFilename): + if not _postAllowsComments(postPostFilename): print('REJECT: reply to post which does not ' + 'allow comments: ' + originalPostId) return False @@ -1658,9 +1661,9 @@ def validPostContent(baseDir: str, nickname: str, domain: str, return True -def obtainAvatarForReplyPost(session, baseDir: str, httpPrefix: str, - domain: str, onionDomain: str, personCache: {}, - postJsonObject: {}, debug: bool) -> None: +def _obtainAvatarForReplyPost(session, baseDir: str, httpPrefix: str, + domain: str, onionDomain: str, personCache: {}, + postJsonObject: {}, debug: bool) -> None: """Tries to obtain the actor for the person being replied to so that their avatar can later be shown """ @@ -1708,7 +1711,7 @@ def obtainAvatarForReplyPost(session, baseDir: str, httpPrefix: str, time.sleep(5) -def dmNotify(baseDir: str, handle: str, url: str) -> None: +def _dmNotify(baseDir: str, handle: str, url: str) -> None: """Creates a notification that a new DM has arrived """ accountDir = baseDir + '/accounts/' + handle @@ -1720,8 +1723,8 @@ def dmNotify(baseDir: str, handle: str, url: str) -> None: fp.write(url) -def alreadyLiked(baseDir: str, nickname: str, domain: str, - postUrl: str, likerActor: str) -> bool: +def _alreadyLiked(baseDir: str, nickname: str, domain: str, + postUrl: str, likerActor: str) -> bool: """Is the given post already liked by the given handle? """ postFilename = \ @@ -1751,8 +1754,8 @@ def alreadyLiked(baseDir: str, nickname: str, domain: str, return False -def likeNotify(baseDir: str, domain: str, onionDomain: str, - handle: str, actor: str, url: str) -> None: +def _likeNotify(baseDir: str, domain: str, onionDomain: str, + handle: str, actor: str, url: str) -> None: """Creates a notification that a like has arrived """ # This is not you liking your own post @@ -1784,7 +1787,7 @@ def likeNotify(baseDir: str, domain: str, onionDomain: str, if likerNickname and likerDomain: likerHandle = likerNickname + '@' + likerDomain else: - print('likeNotify likerHandle: ' + + print('_likeNotify likerHandle: ' + str(likerNickname) + '@' + str(likerDomain)) likerHandle = actor if likerHandle != handle: @@ -1813,7 +1816,7 @@ def likeNotify(baseDir: str, domain: str, onionDomain: str, pass -def replyNotify(baseDir: str, handle: str, url: str) -> None: +def _replyNotify(baseDir: str, handle: str, url: str) -> None: """Creates a notification that a new reply has arrived """ accountDir = baseDir + '/accounts/' + handle @@ -1825,9 +1828,9 @@ def replyNotify(baseDir: str, handle: str, url: str) -> None: fp.write(url) -def gitPatchNotify(baseDir: str, handle: str, - subject: str, content: str, - fromNickname: str, fromDomain: str) -> None: +def _gitPatchNotify(baseDir: str, handle: str, + subject: str, content: str, + fromNickname: str, fromDomain: str) -> None: """Creates a notification that a new git patch has arrived """ accountDir = baseDir + '/accounts/' + handle @@ -1840,7 +1843,7 @@ def gitPatchNotify(baseDir: str, handle: str, fp.write('git ' + handle + ' ' + subject) -def groupHandle(baseDir: str, handle: str) -> bool: +def _groupHandle(baseDir: str, handle: str) -> bool: """Is the given account handle a group? """ actorFile = baseDir + '/accounts/' + handle + '.json' @@ -1852,7 +1855,7 @@ def groupHandle(baseDir: str, handle: str) -> bool: return actorJson['type'] == 'Group' -def getGroupName(baseDir: str, handle: str) -> str: +def _getGroupName(baseDir: str, handle: str) -> str: """Returns the preferred name of a group """ actorFile = baseDir + '/accounts/' + handle + '.json' @@ -1864,11 +1867,11 @@ def getGroupName(baseDir: str, handle: str) -> str: return actorJson['name'] -def sendToGroupMembers(session, baseDir: str, handle: str, port: int, - postJsonObject: {}, - httpPrefix: str, federationList: [], - sendThreads: [], postLog: [], cachedWebfingers: {}, - personCache: {}, debug: bool) -> None: +def _sendToGroupMembers(session, baseDir: str, handle: str, port: int, + postJsonObject: {}, + httpPrefix: str, federationList: [], + sendThreads: [], postLog: [], cachedWebfingers: {}, + personCache: {}, debug: bool) -> None: """When a post arrives for a group send it out to the group members """ followersFile = baseDir + '/accounts/' + handle + '/followers.txt' @@ -1877,7 +1880,7 @@ def sendToGroupMembers(session, baseDir: str, handle: str, port: int, if not postJsonObject.get('object'): return nickname = handle.split('@')[0] -# groupname = getGroupName(baseDir, handle) +# groupname = _getGroupName(baseDir, handle) domain = handle.split('@')[1] domainFull = getFullDomain(domain, port) # set sender @@ -1941,7 +1944,8 @@ def sendToGroupMembers(session, baseDir: str, handle: str, port: int, personCache, debug, __version__) -def inboxUpdateCalendar(baseDir: str, handle: str, postJsonObject: {}) -> None: +def _inboxUpdateCalendar(baseDir: str, handle: str, + postJsonObject: {}) -> None: """Detects whether the tag list on a post contains calendar events and if so saves the post id to a file in the calendar directory for the account @@ -2017,7 +2021,7 @@ def inboxUpdateIndex(boxname: str, baseDir: str, handle: str, return False -def updateLastSeen(baseDir: str, handle: str, actor: str) -> None: +def _updateLastSeen(baseDir: str, handle: str, actor: str) -> None: """Updates the time when the given handle last saw the given actor This can later be used to indicate if accounts are dormant/abandoned/moved """ @@ -2049,127 +2053,125 @@ def updateLastSeen(baseDir: str, handle: str, actor: str) -> None: lastSeenFile.write(str(daysSinceEpoch)) -def inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, - session, keyId: str, handle: str, messageJson: {}, - baseDir: str, httpPrefix: str, sendThreads: [], - postLog: [], cachedWebfingers: {}, personCache: {}, - queue: [], domain: str, - onionDomain: str, i2pDomain: str, - port: int, proxyType: str, - federationList: [], debug: bool, - queueFilename: str, destinationFilename: str, - maxReplies: int, allowDeletion: bool, - maxMentions: int, maxEmoji: int, translate: {}, - unitTest: bool, YTReplacementDomain: str, - showPublishedDateOnly: bool, - allowLocalNetworkAccess: bool) -> bool: +def _inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, + session, keyId: str, handle: str, messageJson: {}, + baseDir: str, httpPrefix: str, sendThreads: [], + postLog: [], cachedWebfingers: {}, personCache: {}, + queue: [], domain: str, + onionDomain: str, i2pDomain: str, + port: int, proxyType: str, + federationList: [], debug: bool, + queueFilename: str, destinationFilename: str, + maxReplies: int, allowDeletion: bool, + maxMentions: int, maxEmoji: int, translate: {}, + unitTest: bool, YTReplacementDomain: str, + showPublishedDateOnly: bool, + allowLocalNetworkAccess: bool) -> bool: """ Anything which needs to be done after initial checks have passed """ actor = keyId if '#' in actor: actor = keyId.split('#')[0] - updateLastSeen(baseDir, handle, actor) + _updateLastSeen(baseDir, handle, actor) - isGroup = groupHandle(baseDir, handle) + isGroup = _groupHandle(baseDir, handle) - if receiveLike(recentPostsCache, - session, handle, isGroup, - baseDir, httpPrefix, - domain, port, - onionDomain, - sendThreads, postLog, - cachedWebfingers, - personCache, - messageJson, - federationList, - debug): + if _receiveLike(recentPostsCache, + session, handle, isGroup, + baseDir, httpPrefix, + domain, port, + onionDomain, + sendThreads, postLog, + cachedWebfingers, + personCache, + messageJson, + federationList, + debug): if debug: print('DEBUG: Like accepted from ' + actor) return False - if receiveUndoLike(recentPostsCache, - session, handle, isGroup, - baseDir, httpPrefix, - domain, port, - sendThreads, postLog, - cachedWebfingers, - personCache, - messageJson, - federationList, - debug): + if _receiveUndoLike(recentPostsCache, + session, handle, isGroup, + baseDir, httpPrefix, + domain, port, + sendThreads, postLog, + cachedWebfingers, + personCache, + messageJson, + federationList, + debug): if debug: print('DEBUG: Undo like accepted from ' + actor) return False - if receiveBookmark(recentPostsCache, - session, handle, isGroup, - baseDir, httpPrefix, - domain, port, - sendThreads, postLog, - cachedWebfingers, - personCache, - messageJson, - federationList, - debug): + if _receiveBookmark(recentPostsCache, + session, handle, isGroup, + baseDir, httpPrefix, + domain, port, + sendThreads, postLog, + cachedWebfingers, + personCache, + messageJson, + federationList, + debug): if debug: print('DEBUG: Bookmark accepted from ' + actor) return False - if receiveUndoBookmark(recentPostsCache, - session, handle, isGroup, - baseDir, httpPrefix, - domain, port, - sendThreads, postLog, - cachedWebfingers, - personCache, - messageJson, - federationList, - debug): + if _receiveUndoBookmark(recentPostsCache, + session, handle, isGroup, + baseDir, httpPrefix, + domain, port, + sendThreads, postLog, + cachedWebfingers, + personCache, + messageJson, + federationList, + debug): if debug: print('DEBUG: Undo bookmark accepted from ' + actor) return False - # labelAccusatoryPost(messageJson, translate) - - if receiveAnnounce(recentPostsCache, - session, handle, isGroup, - baseDir, httpPrefix, - domain, onionDomain, port, - sendThreads, postLog, - cachedWebfingers, - personCache, - messageJson, - federationList, - debug, translate, - YTReplacementDomain): + if _receiveAnnounce(recentPostsCache, + session, handle, isGroup, + baseDir, httpPrefix, + domain, onionDomain, port, + sendThreads, postLog, + cachedWebfingers, + personCache, + messageJson, + federationList, + debug, translate, + YTReplacementDomain): if debug: print('DEBUG: Announce accepted from ' + actor) - if receiveUndoAnnounce(recentPostsCache, - session, handle, isGroup, - baseDir, httpPrefix, - domain, port, - sendThreads, postLog, - cachedWebfingers, - personCache, - messageJson, - federationList, - debug): + if _receiveUndoAnnounce(recentPostsCache, + session, handle, isGroup, + baseDir, httpPrefix, + domain, port, + sendThreads, postLog, + cachedWebfingers, + personCache, + messageJson, + federationList, + debug): if debug: print('DEBUG: Undo announce accepted from ' + actor) return False - if receiveDelete(session, handle, isGroup, - baseDir, httpPrefix, - domain, port, - sendThreads, postLog, - cachedWebfingers, - personCache, - messageJson, - federationList, - debug, allowDeletion, - recentPostsCache): + if _receiveDelete(session, handle, isGroup, + baseDir, httpPrefix, + domain, port, + sendThreads, postLog, + cachedWebfingers, + personCache, + messageJson, + federationList, + debug, allowDeletion, + recentPostsCache): if debug: print('DEBUG: Delete accepted from ' + actor) return False @@ -2188,9 +2190,9 @@ def inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, postJsonObject = messageJson nickname = handle.split('@')[0] - if validPostContent(baseDir, nickname, domain, - postJsonObject, maxMentions, maxEmoji, - allowLocalNetworkAccess): + if _validPostContent(baseDir, nickname, domain, + postJsonObject, maxMentions, maxEmoji, + allowLocalNetworkAccess): if postJsonObject.get('object'): jsonObj = postJsonObject['object'] @@ -2213,10 +2215,10 @@ def inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, jsonObj['summary'], jsonObj['content'], fromNickname, fromDomain): - gitPatchNotify(baseDir, handle, - jsonObj['summary'], - jsonObj['content'], - fromNickname, fromDomain) + _gitPatchNotify(baseDir, handle, + jsonObj['summary'], + jsonObj['content'], + fromNickname, fromDomain) elif '[PATCH]' in jsonObj['content']: print('WARN: git patch not accepted - ' + jsonObj['summary']) @@ -2293,9 +2295,9 @@ def inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, return False # dm index will be updated updateIndexList.append('dm') - dmNotify(baseDir, handle, - httpPrefix + '://' + domain + '/users/' + - nickname + '/dm') + _dmNotify(baseDir, handle, + httpPrefix + '://' + domain + '/users/' + + nickname + '/dm') # get the actor being replied to domainFull = getFullDomain(domain, port) @@ -2313,10 +2315,10 @@ def inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, if isinstance(inReplyTo, str): if not isMuted(baseDir, nickname, domain, inReplyTo): - replyNotify(baseDir, handle, - httpPrefix + '://' + domain + - '/users/' + nickname + - '/tlreplies') + _replyNotify(baseDir, handle, + httpPrefix + '://' + domain + + '/users/' + nickname + + '/tlreplies') else: isReplyToMutedPost = True @@ -2333,9 +2335,9 @@ def inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, updateIndexList.append('tlevents') # get the avatar for a reply/announce - obtainAvatarForReplyPost(session, baseDir, - httpPrefix, domain, onionDomain, - personCache, postJsonObject, debug) + _obtainAvatarForReplyPost(session, baseDir, + httpPrefix, domain, onionDomain, + personCache, postJsonObject, debug) # save the post to file if saveJson(postJsonObject, destinationFilename): @@ -2359,18 +2361,18 @@ def inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, print('Saving inbox post as html to cache') htmlCacheStartTime = time.time() - inboxStorePostToHtmlCache(recentPostsCache, - maxRecentPosts, - translate, baseDir, - httpPrefix, - session, cachedWebfingers, - personCache, - handle.split('@')[0], - domain, port, - postJsonObject, - allowDeletion, - boxname, - showPublishedDateOnly) + _inboxStorePostToHtmlCache(recentPostsCache, + maxRecentPosts, + translate, baseDir, + httpPrefix, + session, cachedWebfingers, + personCache, + handle.split('@')[0], + domain, port, + postJsonObject, + allowDeletion, + boxname, + showPublishedDateOnly) if debug: timeDiff = \ str(int((time.time() - htmlCacheStartTime) * @@ -2379,17 +2381,17 @@ def inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, ' post as html to cache in ' + timeDiff + ' mS') - inboxUpdateCalendar(baseDir, handle, postJsonObject) + _inboxUpdateCalendar(baseDir, handle, postJsonObject) storeHashTags(baseDir, handle.split('@')[0], postJsonObject) # send the post out to group members if isGroup: - sendToGroupMembers(session, baseDir, handle, port, - postJsonObject, - httpPrefix, federationList, sendThreads, - postLog, cachedWebfingers, personCache, - debug) + _sendToGroupMembers(session, baseDir, handle, port, + postJsonObject, + httpPrefix, federationList, sendThreads, + postLog, cachedWebfingers, personCache, + debug) # if the post wasn't saved if not os.path.isfile(destinationFilename): @@ -2420,7 +2422,7 @@ def clearQueueItems(baseDir: str, queue: []) -> None: print('Removed ' + str(ctr) + ' inbox queue items') -def restoreQueueItems(baseDir: str, queue: []) -> None: +def _restoreQueueItems(baseDir: str, queue: []) -> None: """Checks the queue for each account and appends filenames """ queue.clear() @@ -2483,7 +2485,7 @@ def runInboxQueue(recentPostsCache: {}, maxRecentPosts: int, # if queue processing was interrupted (eg server crash) # then this loads any outstanding items back into the queue - restoreQueueItems(baseDir, queue) + _restoreQueueItems(baseDir, queue) # keep track of numbers of incoming posts per day quotasLastUpdateDaily = int(time.time()) @@ -2515,7 +2517,7 @@ def runInboxQueue(recentPostsCache: {}, maxRecentPosts: int, queueRestoreCtr += 1 if queueRestoreCtr >= 30: queueRestoreCtr = 0 - restoreQueueItems(baseDir, queue) + _restoreQueueItems(baseDir, queue) continue currTime = int(time.time()) @@ -2731,14 +2733,14 @@ def runInboxQueue(recentPostsCache: {}, maxRecentPosts: int, # if queueJson['post'].get('id'): # queueJson['post']['id']=queueJson['id'] - if receiveUndo(session, - baseDir, httpPrefix, port, - sendThreads, postLog, - cachedWebfingers, - personCache, - queueJson['post'], - federationList, - debug): + if _receiveUndo(session, + baseDir, httpPrefix, port, + sendThreads, postLog, + cachedWebfingers, + personCache, + queueJson['post'], + federationList, + debug): print('Queue: Undo accepted from ' + keyId) if os.path.isfile(queueFilename): os.remove(queueFilename) @@ -2782,16 +2784,16 @@ def runInboxQueue(recentPostsCache: {}, maxRecentPosts: int, queue.pop(0) continue - if receiveEventPost(recentPostsCache, session, - baseDir, httpPrefix, - domain, port, - sendThreads, postLog, - cachedWebfingers, - personCache, - queueJson['post'], - federationList, - queueJson['postNickname'], - debug): + if _receiveEventPost(recentPostsCache, session, + baseDir, httpPrefix, + domain, port, + sendThreads, postLog, + cachedWebfingers, + personCache, + queueJson['post'], + federationList, + queueJson['postNickname'], + debug): print('Queue: Event activity accepted from ' + keyId) if os.path.isfile(queueFilename): os.remove(queueFilename) @@ -2799,16 +2801,16 @@ def runInboxQueue(recentPostsCache: {}, maxRecentPosts: int, queue.pop(0) continue - if receiveUpdate(recentPostsCache, session, - baseDir, httpPrefix, - domain, port, - sendThreads, postLog, - cachedWebfingers, - personCache, - queueJson['post'], - federationList, - queueJson['postNickname'], - debug): + if _receiveUpdate(recentPostsCache, session, + baseDir, httpPrefix, + domain, port, + sendThreads, postLog, + cachedWebfingers, + personCache, + queueJson['post'], + federationList, + queueJson['postNickname'], + debug): print('Queue: Update accepted from ' + keyId) if os.path.isfile(queueFilename): os.remove(queueFilename) @@ -2818,8 +2820,8 @@ def runInboxQueue(recentPostsCache: {}, maxRecentPosts: int, # get recipients list recipientsDict, recipientsDictFollowers = \ - inboxPostRecipients(baseDir, queueJson['post'], - httpPrefix, domain, port, debug) + _inboxPostRecipients(baseDir, queueJson['post'], + httpPrefix, domain, port, debug) if len(recipientsDict.items()) == 0 and \ len(recipientsDictFollowers.items()) == 0: print('Queue: no recipients were resolved ' + @@ -2866,26 +2868,26 @@ def runInboxQueue(recentPostsCache: {}, maxRecentPosts: int, for handle, capsId in recipientsDict.items(): destination = \ queueJson['destination'].replace(inboxHandle, handle) - inboxAfterInitial(recentPostsCache, - maxRecentPosts, - session, keyId, handle, - queueJson['post'], - baseDir, httpPrefix, - sendThreads, postLog, - cachedWebfingers, - personCache, queue, - domain, - onionDomain, i2pDomain, - port, proxyType, - federationList, - debug, - queueFilename, destination, - maxReplies, allowDeletion, - maxMentions, maxEmoji, - translate, unitTest, - YTReplacementDomain, - showPublishedDateOnly, - allowLocalNetworkAccess) + _inboxAfterInitial(recentPostsCache, + maxRecentPosts, + session, keyId, handle, + queueJson['post'], + baseDir, httpPrefix, + sendThreads, postLog, + cachedWebfingers, + personCache, queue, + domain, + onionDomain, i2pDomain, + port, proxyType, + federationList, + debug, + queueFilename, destination, + maxReplies, allowDeletion, + maxMentions, maxEmoji, + translate, unitTest, + YTReplacementDomain, + showPublishedDateOnly, + allowLocalNetworkAccess) if debug: pprint(queueJson['post']) diff --git a/jsonldsig.py b/jsonldsig.py index 07f6c126d..30a09e961 100644 --- a/jsonldsig.py +++ b/jsonldsig.py @@ -28,21 +28,21 @@ import base64 import json -def b64safeEncode(payload: {}) -> str: +def _b64safeEncode(payload: {}) -> str: """ b64 url safe encoding with the padding removed. """ return base64.urlsafe_b64encode(payload).rstrip(b'=') -def b64safeDecode(payload: {}) -> str: +def _b64safeDecode(payload: {}) -> str: """ b64 url safe decoding with the padding added. """ return base64.urlsafe_b64decode(payload + b'=' * (4 - len(payload) % 4)) -def normalizeJson(payload: {}) -> str: +def _normalizeJson(payload: {}) -> str: """ Normalize with URDNA2015 """ @@ -50,7 +50,7 @@ def normalizeJson(payload: {}) -> str: sort_keys=True).encode('utf-8') -def signRs256(payload: {}, privateKeyPem: str) -> str: +def _signRs256(payload: {}, privateKeyPem: str) -> str: """ Produce a RS256 signature of the payload """ @@ -60,7 +60,7 @@ def signRs256(payload: {}, privateKeyPem: str) -> str: return signature -def verifyRs256(payload: {}, signature: str, publicKeyPem: str) -> bool: +def _verifyRs256(payload: {}, signature: str, publicKeyPem: str) -> bool: """ Verifies a RS256 signature """ @@ -69,7 +69,7 @@ def verifyRs256(payload: {}, signature: str, publicKeyPem: str) -> bool: return verifier.verify(SHA256.new(payload), signature) -def signJws(payload: {}, privateKeyPem: str) -> str: +def _signJws(payload: {}, privateKeyPem: str) -> str: """ Prepare payload to sign """ @@ -78,28 +78,28 @@ def signJws(payload: {}, privateKeyPem: str) -> str: 'b64': False, 'crit': ['b64'] } - normalizedJson = normalizeJson(header) - encodedHeader = b64safeEncode(normalizedJson) + normalizedJson = _normalizeJson(header) + encodedHeader = _b64safeEncode(normalizedJson) preparedPayload = b'.'.join([encodedHeader, payload]) - signature = signRs256(preparedPayload, privateKeyPem) - encodedSignature = b64safeEncode(signature) + signature = _signRs256(preparedPayload, privateKeyPem) + encodedSignature = _b64safeEncode(signature) jwsSignature = b'..'.join([encodedHeader, encodedSignature]) return jwsSignature -def verifyJws(payload: {}, jwsSignature: str, publicKeyPem: str) -> bool: +def _verifyJws(payload: {}, jwsSignature: str, publicKeyPem: str) -> bool: """ Verifies a signature using the given public key """ encodedHeader, encodedSignature = jwsSignature.split(b'..') - signature = b64safeDecode(encodedSignature) + signature = _b64safeDecode(encodedSignature) payload = b'.'.join([encodedHeader, payload]) - return verifyRs256(payload, signature, publicKeyPem) + return _verifyRs256(payload, signature, publicKeyPem) -def jsonldNormalize(jldDocument: str): +def _jsonldNormalize(jldDocument: str): """ Normalize and hash the json-ld document """ @@ -117,8 +117,8 @@ def jsonldSign(jldDocument: {}, privateKeyPem: str) -> {}: Produces a signed JSON-LD document with a Json Web Signature """ jldDocument = deepcopy(jldDocument) - normalizedJldHash = jsonldNormalize(jldDocument) - jwsSignature = signJws(normalizedJldHash, privateKeyPem) + normalizedJldHash = _jsonldNormalize(jldDocument) + jwsSignature = _signJws(normalizedJldHash, privateKeyPem) # construct the signature document and add it to jsonld signature = { @@ -138,9 +138,9 @@ def jsonldVerify(signedJldDocument: {}, publicKeyPem: str) -> bool: signedJldDocument = deepcopy(signedJldDocument) signature = signedJldDocument.pop('signature') jwsSignature = signature['signatureValue'].encode('utf-8') - normalizedJldHash = jsonldNormalize(signedJldDocument) + normalizedJldHash = _jsonldNormalize(signedJldDocument) - return verifyJws(normalizedJldHash, jwsSignature, publicKeyPem) + return _verifyJws(normalizedJldHash, jwsSignature, publicKeyPem) def testSignJsonld(jldDocument: {}, privateKeyPem: str) -> {}: diff --git a/like.py b/like.py index da83e1a51..29efeda3f 100644 --- a/like.py +++ b/like.py @@ -50,15 +50,15 @@ def noOfLikes(postJsonObject: {}) -> int: return len(postJsonObject['object']['likes']['items']) -def like(recentPostsCache: {}, - session, baseDir: str, federationList: [], - nickname: str, domain: str, port: int, - ccList: [], httpPrefix: str, - objectUrl: str, actorLiked: str, - clientToServer: bool, - sendThreads: [], postLog: [], - personCache: {}, cachedWebfingers: {}, - debug: bool, projectVersion: str) -> {}: +def _like(recentPostsCache: {}, + session, baseDir: str, federationList: [], + nickname: str, domain: str, port: int, + ccList: [], httpPrefix: str, + objectUrl: str, actorLiked: str, + clientToServer: bool, + sendThreads: [], postLog: [], + personCache: {}, cachedWebfingers: {}, + debug: bool, projectVersion: str) -> {}: """Creates a like actor is the person doing the liking 'to' might be a specific person (actor) whose post was liked @@ -134,11 +134,11 @@ def likePost(recentPostsCache: {}, actorLiked = httpPrefix + '://' + likeDomain + '/users/' + likeNickname objectUrl = actorLiked + '/statuses/' + str(likeStatusNumber) - return like(recentPostsCache, - session, baseDir, federationList, nickname, domain, port, - ccList, httpPrefix, objectUrl, actorLiked, clientToServer, - sendThreads, postLog, personCache, cachedWebfingers, - debug, projectVersion) + return _like(recentPostsCache, + session, baseDir, federationList, nickname, domain, port, + ccList, httpPrefix, objectUrl, actorLiked, clientToServer, + sendThreads, postLog, personCache, cachedWebfingers, + debug, projectVersion) def sendLikeViaServer(baseDir: str, session, diff --git a/manualapprove.py b/manualapprove.py index e3648734e..7c0eb9ce1 100644 --- a/manualapprove.py +++ b/manualapprove.py @@ -62,7 +62,7 @@ def manualDenyFollowRequest(session, baseDir: str, print('Follow request from ' + denyHandle + ' was denied.') -def approveFollowerHandle(accountDir: str, approveHandle: str) -> None: +def _approveFollowerHandle(accountDir: str, approveHandle: str) -> None: """ Record manually approved handles so that if they unfollow and then re-follow later then they don't need to be manually approved again """ @@ -203,7 +203,7 @@ def manualApproveFollowRequest(session, baseDir: str, # in followers.txt if approveHandleFull in open(followersFilename).read(): # mark this handle as approved for following - approveFollowerHandle(accountDir, approveHandle) + _approveFollowerHandle(accountDir, approveHandle) # update the follow requests with the handles not yet approved os.rename(approveFollowsFilename + '.new', approveFollowsFilename) # remove the .follow file diff --git a/media.py b/media.py index 9d3308f80..763ce77d9 100644 --- a/media.py +++ b/media.py @@ -56,12 +56,12 @@ def removeMetaData(imageFilename: str, outputFilename: str) -> None: os.system('/usr/bin/mogrify -strip ' + outputFilename) # nosec -def getImageHash(imageFilename: str) -> str: +def _getImageHash(imageFilename: str) -> str: value = numpy.array(Image.open(imageFilename).convert("RGB")) return blurhash_encode(value) -def isMedia(imageFilename: str) -> bool: +def _isMedia(imageFilename: str) -> bool: permittedMedia = getMediaExtensions() for m in permittedMedia: if imageFilename.endswith('.' + m): @@ -103,7 +103,7 @@ def getAttachmentMediaType(filename: str) -> str: return mediaType -def updateEtag(mediaFilename: str) -> None: +def _updateEtag(mediaFilename: str) -> None: """ calculate the etag, which is a sha1 of the data """ # only create etags for media @@ -143,7 +143,7 @@ def attachMedia(baseDir: str, httpPrefix: str, domain: str, port: int, Blurhash is optional, since low power systems may take a long time to calculate it """ - if not isMedia(imageFilename): + if not _isMedia(imageFilename): return postJson fileExtension = None @@ -182,7 +182,7 @@ def attachMedia(baseDir: str, httpPrefix: str, domain: str, port: int, if mediaType.startswith('image/'): attachmentJson['focialPoint'] = [0.0, 0.0] if useBlurhash: - attachmentJson['blurhash'] = getImageHash(imageFilename) + attachmentJson['blurhash'] = _getImageHash(imageFilename) postJson['attachment'] = [attachmentJson] if baseDir: @@ -190,7 +190,7 @@ def attachMedia(baseDir: str, httpPrefix: str, domain: str, port: int, removeMetaData(imageFilename, mediaFilename) else: copyfile(imageFilename, mediaFilename) - updateEtag(mediaFilename) + _updateEtag(mediaFilename) return postJson diff --git a/migrate.py b/migrate.py index 4b04d8520..7f52b40d7 100644 --- a/migrate.py +++ b/migrate.py @@ -9,8 +9,8 @@ __status__ = "Production" import os -def migrateFollows(followFilename: str, oldHandle: str, - newHandle: str) -> None: +def _migrateFollows(followFilename: str, oldHandle: str, + newHandle: str) -> None: """Changes a handle within following or followers list """ if not os.path.isfile(followFilename): @@ -48,7 +48,7 @@ def migrateAccount(baseDir: str, oldHandle: str, newHandle: str) -> None: if '@' in handle: accountDir = baseDir + '/accounts/' + handle followFilename = accountDir + '/following.txt' - migrateFollows(followFilename, oldHandle, newHandle) + _migrateFollows(followFilename, oldHandle, newHandle) followFilename = accountDir + '/followers.txt' - migrateFollows(followFilename, oldHandle, newHandle) + _migrateFollows(followFilename, oldHandle, newHandle) break diff --git a/newsdaemon.py b/newsdaemon.py index c89ae24ef..ff3952926 100644 --- a/newsdaemon.py +++ b/newsdaemon.py @@ -35,7 +35,7 @@ from inbox import storeHashTags from session import createSession -def updateFeedsOutboxIndex(baseDir: str, domain: str, postId: str) -> None: +def _updateFeedsOutboxIndex(baseDir: str, domain: str, postId: str) -> None: """Updates the index used for imported RSS feeds """ basePath = baseDir + '/accounts/news@' + domain @@ -59,7 +59,7 @@ def updateFeedsOutboxIndex(baseDir: str, domain: str, postId: str) -> None: feedsFile.close() -def saveArrivedTime(baseDir: str, postFilename: str, arrived: str) -> None: +def _saveArrivedTime(baseDir: str, postFilename: str, arrived: str) -> None: """Saves the time when an rss post arrived to a file """ arrivedFile = open(postFilename + '.arrived', 'w+') @@ -68,7 +68,7 @@ def saveArrivedTime(baseDir: str, postFilename: str, arrived: str) -> None: arrivedFile.close() -def removeControlCharacters(content: str) -> str: +def _removeControlCharacters(content: str) -> str: """Remove escaped html """ if '&' in content: @@ -227,14 +227,14 @@ def hashtagRuleTree(operators: [], return tree -def newswireHashtagProcessing(session, baseDir: str, postJsonObject: {}, - hashtags: [], httpPrefix: str, - domain: str, port: int, - personCache: {}, - cachedWebfingers: {}, - federationList: [], - sendThreads: [], postLog: [], - moderated: bool, url: str) -> bool: +def _newswireHashtagProcessing(session, baseDir: str, postJsonObject: {}, + hashtags: [], httpPrefix: str, + domain: str, port: int, + personCache: {}, + cachedWebfingers: {}, + federationList: [], + sendThreads: [], postLog: [], + moderated: bool, url: str) -> bool: """Applies hashtag rules to a news post. Returns true if the post should be saved to the news timeline of this instance @@ -356,9 +356,9 @@ def newswireHashtagProcessing(session, baseDir: str, postJsonObject: {}, return True -def createNewsMirror(baseDir: str, domain: str, - postIdNumber: str, url: str, - maxMirroredArticles: int) -> bool: +def _createNewsMirror(baseDir: str, domain: str, + postIdNumber: str, url: str, + maxMirroredArticles: int) -> bool: """Creates a local mirror of a news article """ if '|' in url or '>' in url: @@ -446,17 +446,17 @@ def createNewsMirror(baseDir: str, domain: str, return True -def convertRSStoActivityPub(baseDir: str, httpPrefix: str, - domain: str, port: int, - newswire: {}, - translate: {}, - recentPostsCache: {}, maxRecentPosts: int, - session, cachedWebfingers: {}, - personCache: {}, - federationList: [], - sendThreads: [], postLog: [], - maxMirroredArticles: int, - allowLocalNetworkAccess: bool) -> None: +def _convertRSStoActivityPub(baseDir: str, httpPrefix: str, + domain: str, port: int, + newswire: {}, + translate: {}, + recentPostsCache: {}, maxRecentPosts: int, + session, cachedWebfingers: {}, + personCache: {}, + federationList: [], + sendThreads: [], postLog: [], + maxMirroredArticles: int, + allowLocalNetworkAccess: bool) -> None: """Converts rss items in a newswire into posts """ if not newswire: @@ -497,7 +497,7 @@ def convertRSStoActivityPub(baseDir: str, httpPrefix: str, newswire[originalDateStr][3] = filename continue - rssTitle = removeControlCharacters(item[0]) + rssTitle = _removeControlCharacters(item[0]) url = item[1] if dangerousMarkup(url, allowLocalNetworkAccess) or \ dangerousMarkup(rssTitle, allowLocalNetworkAccess): @@ -505,7 +505,7 @@ def convertRSStoActivityPub(baseDir: str, httpPrefix: str, rssDescription = '' # get the rss description if it exists - rssDescription = removeControlCharacters(item[4]) + rssDescription = _removeControlCharacters(item[4]) if rssDescription.startswith('', '') @@ -555,8 +555,8 @@ def convertRSStoActivityPub(baseDir: str, httpPrefix: str, continue if mirrored: - if not createNewsMirror(baseDir, domain, statusNumber, - url, maxMirroredArticles): + if not _createNewsMirror(baseDir, domain, statusNumber, + url, maxMirroredArticles): continue idStr = \ @@ -590,12 +590,12 @@ def convertRSStoActivityPub(baseDir: str, httpPrefix: str, moderated = item[5] - savePost = newswireHashtagProcessing(session, baseDir, blog, hashtags, - httpPrefix, domain, port, - personCache, cachedWebfingers, - federationList, - sendThreads, postLog, - moderated, url) + savePost = _newswireHashtagProcessing(session, baseDir, blog, hashtags, + httpPrefix, domain, port, + personCache, cachedWebfingers, + federationList, + sendThreads, postLog, + moderated, url) # save the post and update the index if savePost: @@ -628,7 +628,7 @@ def convertRSStoActivityPub(baseDir: str, httpPrefix: str, blog['object']['content'] = content # update the newswire tags if new ones have been found by - # newswireHashtagProcessing + # _newswireHashtagProcessing for tag in hashtags: if tag not in newswire[originalDateStr][6]: newswire[originalDateStr][6].append(tag) @@ -637,14 +637,14 @@ def convertRSStoActivityPub(baseDir: str, httpPrefix: str, clearFromPostCaches(baseDir, recentPostsCache, postId) if saveJson(blog, filename): - updateFeedsOutboxIndex(baseDir, domain, postId + '.json') + _updateFeedsOutboxIndex(baseDir, domain, postId + '.json') # Save a file containing the time when the post arrived # this can then later be used to construct the news timeline # excluding items during the voting period if moderated: - saveArrivedTime(baseDir, filename, - blog['object']['arrived']) + _saveArrivedTime(baseDir, filename, + blog['object']['arrived']) else: if os.path.isfile(filename + '.arrived'): os.remove(filename + '.arrived') @@ -658,7 +658,7 @@ def convertRSStoActivityPub(baseDir: str, httpPrefix: str, newswire[originalDateStr][3] = filename -def mergeWithPreviousNewswire(oldNewswire: {}, newNewswire: {}) -> None: +def _mergeWithPreviousNewswire(oldNewswire: {}, newNewswire: {}) -> None: """Preserve any votes or generated activitypub post filename as rss feeds are updated """ @@ -707,26 +707,26 @@ def runNewswireDaemon(baseDir: str, httpd, if os.path.isfile(newswireStateFilename): httpd.newswire = loadJson(newswireStateFilename) - mergeWithPreviousNewswire(httpd.newswire, newNewswire) + _mergeWithPreviousNewswire(httpd.newswire, newNewswire) httpd.newswire = newNewswire if newNewswire: saveJson(httpd.newswire, newswireStateFilename) print('Newswire updated') - convertRSStoActivityPub(baseDir, - httpPrefix, domain, port, - newNewswire, translate, - httpd.recentPostsCache, - httpd.maxRecentPosts, - httpd.session, - httpd.cachedWebfingers, - httpd.personCache, - httpd.federationList, - httpd.sendThreads, - httpd.postLog, - httpd.maxMirroredArticles, - httpd.allowLocalNetworkAccess) + _convertRSStoActivityPub(baseDir, + httpPrefix, domain, port, + newNewswire, translate, + httpd.recentPostsCache, + httpd.maxRecentPosts, + httpd.session, + httpd.cachedWebfingers, + httpd.personCache, + httpd.federationList, + httpd.sendThreads, + httpd.postLog, + httpd.maxMirroredArticles, + httpd.allowLocalNetworkAccess) print('Newswire feed converted to ActivityPub') if httpd.maxNewsPosts > 0: diff --git a/newswire.py b/newswire.py index 452cd076b..657641c47 100644 --- a/newswire.py +++ b/newswire.py @@ -29,7 +29,7 @@ from blocking import isBlockedHashtag from filters import isFiltered -def removeCDATA(text: str) -> str: +def _removeCDATA(text: str) -> str: """Removes any CDATA from the given text """ if 'CDATA[' in text: @@ -95,13 +95,13 @@ def getNewswireTags(text: str, maxTags: int) -> []: return tags -def addNewswireDictEntry(baseDir: str, domain: str, - newswire: {}, dateStr: str, - title: str, link: str, - votesStatus: str, postFilename: str, - description: str, moderated: bool, - mirrored: bool, - tags=[], maxTags=32) -> None: +def _addNewswireDictEntry(baseDir: str, domain: str, + newswire: {}, dateStr: str, + title: str, link: str, + votesStatus: str, postFilename: str, + description: str, moderated: bool, + mirrored: bool, + tags=[], maxTags=32) -> None: """Update the newswire dictionary """ # remove any markup @@ -143,7 +143,7 @@ def addNewswireDictEntry(baseDir: str, domain: str, ] -def validFeedDate(pubDate: str) -> bool: +def _validFeedDate(pubDate: str) -> bool: # convert from YY-MM-DD HH:MM:SS+00:00 to # YY-MM-DDTHH:MM:SSZ postDate = pubDate.replace(' ', 'T').replace('+00:00', 'Z') @@ -219,12 +219,12 @@ def loadHashtagCategories(baseDir: str, language: str) -> None: with open(hashtagCategoriesFilename, 'r') as fp: xmlStr = fp.read() - xml2StrToHashtagCategories(baseDir, xmlStr, 1024, True) + _xml2StrToHashtagCategories(baseDir, xmlStr, 1024, True) -def xml2StrToHashtagCategories(baseDir: str, xmlStr: str, - maxCategoriesFeedItemSizeKb: int, - force=False) -> None: +def _xml2StrToHashtagCategories(baseDir: str, xmlStr: str, + maxCategoriesFeedItemSizeKb: int, + force=False) -> None: """Updates hashtag categories based upon an rss feed """ rssItems = xmlStr.split('') @@ -261,11 +261,11 @@ def xml2StrToHashtagCategories(baseDir: str, xmlStr: str, setHashtagCategory(baseDir, hashtag, categoryStr, force) -def xml2StrToDict(baseDir: str, domain: str, xmlStr: str, - moderated: bool, mirrored: bool, - maxPostsPerSource: int, - maxFeedItemSizeKb: int, - maxCategoriesFeedItemSizeKb: int) -> {}: +def _xml2StrToDict(baseDir: str, domain: str, xmlStr: str, + moderated: bool, mirrored: bool, + maxPostsPerSource: int, + maxFeedItemSizeKb: int, + maxCategoriesFeedItemSizeKb: int) -> {}: """Converts an xml RSS 2.0 string to a dictionary """ if '' not in xmlStr: @@ -274,8 +274,8 @@ def xml2StrToDict(baseDir: str, domain: str, xmlStr: str, # is this an rss feed containing hashtag categories? if '#categories' in xmlStr: - xml2StrToHashtagCategories(baseDir, xmlStr, - maxCategoriesFeedItemSizeKb) + _xml2StrToHashtagCategories(baseDir, xmlStr, + maxCategoriesFeedItemSizeKb) return {} rssItems = xmlStr.split('') @@ -300,17 +300,17 @@ def xml2StrToDict(baseDir: str, domain: str, xmlStr: str, if '' not in rssItem: continue title = rssItem.split('')[1] - title = removeCDATA(title.split('')[0]) + title = _removeCDATA(title.split('')[0]) description = '' if '' in rssItem and '' in rssItem: description = rssItem.split('')[1] - description = removeCDATA(description.split('')[0]) + description = _removeCDATA(description.split('')[0]) else: if '' in rssItem and \ '' in rssItem: description = rssItem.split('')[1] description = description.split('')[0] - description = removeCDATA(description) + description = _removeCDATA(description) link = rssItem.split('')[1] link = link.split('')[0] if '://' not in link: @@ -325,14 +325,14 @@ def xml2StrToDict(baseDir: str, domain: str, xmlStr: str, pubDateStr = parseFeedDate(pubDate) if pubDateStr: - if validFeedDate(pubDateStr): + if _validFeedDate(pubDateStr): postFilename = '' votesStatus = [] - addNewswireDictEntry(baseDir, domain, - result, pubDateStr, - title, link, - votesStatus, postFilename, - description, moderated, mirrored) + _addNewswireDictEntry(baseDir, domain, + result, pubDateStr, + title, link, + votesStatus, postFilename, + description, moderated, mirrored) postCtr += 1 if postCtr >= maxPostsPerSource: break @@ -341,11 +341,11 @@ def xml2StrToDict(baseDir: str, domain: str, xmlStr: str, return result -def xml1StrToDict(baseDir: str, domain: str, xmlStr: str, - moderated: bool, mirrored: bool, - maxPostsPerSource: int, - maxFeedItemSizeKb: int, - maxCategoriesFeedItemSizeKb: int) -> {}: +def _xml1StrToDict(baseDir: str, domain: str, xmlStr: str, + moderated: bool, mirrored: bool, + maxPostsPerSource: int, + maxFeedItemSizeKb: int, + maxCategoriesFeedItemSizeKb: int) -> {}: """Converts an xml RSS 1.0 string to a dictionary https://validator.w3.org/feed/docs/rss1.html """ @@ -356,8 +356,8 @@ def xml1StrToDict(baseDir: str, domain: str, xmlStr: str, # is this an rss feed containing hashtag categories? if '#categories' in xmlStr: - xml2StrToHashtagCategories(baseDir, xmlStr, - maxCategoriesFeedItemSizeKb) + _xml2StrToHashtagCategories(baseDir, xmlStr, + maxCategoriesFeedItemSizeKb) return {} rssItems = xmlStr.split(itemStr) @@ -384,17 +384,17 @@ def xml1StrToDict(baseDir: str, domain: str, xmlStr: str, if '' not in rssItem: continue title = rssItem.split('')[1] - title = removeCDATA(title.split('')[0]) + title = _removeCDATA(title.split('')[0]) description = '' if '' in rssItem and '' in rssItem: description = rssItem.split('')[1] - description = removeCDATA(description.split('')[0]) + description = _removeCDATA(description.split('')[0]) else: if '' in rssItem and \ '' in rssItem: description = rssItem.split('')[1] description = description.split('')[0] - description = removeCDATA(description) + description = _removeCDATA(description) link = rssItem.split('')[1] link = link.split('')[0] if '://' not in link: @@ -409,14 +409,14 @@ def xml1StrToDict(baseDir: str, domain: str, xmlStr: str, pubDateStr = parseFeedDate(pubDate) if pubDateStr: - if validFeedDate(pubDateStr): + if _validFeedDate(pubDateStr): postFilename = '' votesStatus = [] - addNewswireDictEntry(baseDir, domain, - result, pubDateStr, - title, link, - votesStatus, postFilename, - description, moderated, mirrored) + _addNewswireDictEntry(baseDir, domain, + result, pubDateStr, + title, link, + votesStatus, postFilename, + description, moderated, mirrored) postCtr += 1 if postCtr >= maxPostsPerSource: break @@ -425,10 +425,10 @@ def xml1StrToDict(baseDir: str, domain: str, xmlStr: str, return result -def atomFeedToDict(baseDir: str, domain: str, xmlStr: str, - moderated: bool, mirrored: bool, - maxPostsPerSource: int, - maxFeedItemSizeKb: int) -> {}: +def _atomFeedToDict(baseDir: str, domain: str, xmlStr: str, + moderated: bool, mirrored: bool, + maxPostsPerSource: int, + maxFeedItemSizeKb: int) -> {}: """Converts an atom feed string to a dictionary """ if '' not in xmlStr: @@ -456,17 +456,17 @@ def atomFeedToDict(baseDir: str, domain: str, xmlStr: str, if '' not in atomItem: continue title = atomItem.split('')[1] - title = removeCDATA(title.split('')[0]) + title = _removeCDATA(title.split('')[0]) description = '' if '' in atomItem and '' in atomItem: description = atomItem.split('')[1] - description = removeCDATA(description.split('')[0]) + description = _removeCDATA(description.split('')[0]) else: if '' in atomItem and \ '' in atomItem: description = atomItem.split('')[1] description = description.split('')[0] - description = removeCDATA(description) + description = _removeCDATA(description) link = atomItem.split('')[1] link = link.split('')[0] if '://' not in link: @@ -481,14 +481,14 @@ def atomFeedToDict(baseDir: str, domain: str, xmlStr: str, pubDateStr = parseFeedDate(pubDate) if pubDateStr: - if validFeedDate(pubDateStr): + if _validFeedDate(pubDateStr): postFilename = '' votesStatus = [] - addNewswireDictEntry(baseDir, domain, - result, pubDateStr, - title, link, - votesStatus, postFilename, - description, moderated, mirrored) + _addNewswireDictEntry(baseDir, domain, + result, pubDateStr, + title, link, + votesStatus, postFilename, + description, moderated, mirrored) postCtr += 1 if postCtr >= maxPostsPerSource: break @@ -497,10 +497,10 @@ def atomFeedToDict(baseDir: str, domain: str, xmlStr: str, return result -def atomFeedYTToDict(baseDir: str, domain: str, xmlStr: str, - moderated: bool, mirrored: bool, - maxPostsPerSource: int, - maxFeedItemSizeKb: int) -> {}: +def _atomFeedYTToDict(baseDir: str, domain: str, xmlStr: str, + moderated: bool, mirrored: bool, + maxPostsPerSource: int, + maxFeedItemSizeKb: int) -> {}: """Converts an atom-style YouTube feed string to a dictionary """ if '' not in xmlStr: @@ -532,17 +532,17 @@ def atomFeedYTToDict(baseDir: str, domain: str, xmlStr: str, if '' not in atomItem: continue title = atomItem.split('')[1] - title = removeCDATA(title.split('')[0]) + title = _removeCDATA(title.split('')[0]) description = '' if '' in atomItem and \ '' in atomItem: description = atomItem.split('')[1] description = description.split('')[0] - description = removeCDATA(description) + description = _removeCDATA(description) elif '' in atomItem and '' in atomItem: description = atomItem.split('')[1] description = description.split('')[0] - description = removeCDATA(description) + description = _removeCDATA(description) link = atomItem.split('')[1] link = link.split('')[0] link = 'https://www.youtube.com/watch?v=' + link.strip() @@ -551,14 +551,14 @@ def atomFeedYTToDict(baseDir: str, domain: str, xmlStr: str, pubDateStr = parseFeedDate(pubDate) if pubDateStr: - if validFeedDate(pubDateStr): + if _validFeedDate(pubDateStr): postFilename = '' votesStatus = [] - addNewswireDictEntry(baseDir, domain, - result, pubDateStr, - title, link, - votesStatus, postFilename, - description, moderated, mirrored) + _addNewswireDictEntry(baseDir, domain, + result, pubDateStr, + title, link, + votesStatus, postFilename, + description, moderated, mirrored) postCtr += 1 if postCtr >= maxPostsPerSource: break @@ -567,36 +567,36 @@ def atomFeedYTToDict(baseDir: str, domain: str, xmlStr: str, return result -def xmlStrToDict(baseDir: str, domain: str, xmlStr: str, - moderated: bool, mirrored: bool, - maxPostsPerSource: int, - maxFeedItemSizeKb: int, - maxCategoriesFeedItemSizeKb: int) -> {}: +def _xmlStrToDict(baseDir: str, domain: str, xmlStr: str, + moderated: bool, mirrored: bool, + maxPostsPerSource: int, + maxFeedItemSizeKb: int, + maxCategoriesFeedItemSizeKb: int) -> {}: """Converts an xml string to a dictionary """ if '' in xmlStr and '' in xmlStr: print('YouTube feed: reading') - return atomFeedYTToDict(baseDir, domain, - xmlStr, moderated, mirrored, - maxPostsPerSource, maxFeedItemSizeKb) + return _atomFeedYTToDict(baseDir, domain, + xmlStr, moderated, mirrored, + maxPostsPerSource, maxFeedItemSizeKb) elif 'rss version="2.0"' in xmlStr: - return xml2StrToDict(baseDir, domain, - xmlStr, moderated, mirrored, - maxPostsPerSource, maxFeedItemSizeKb, - maxCategoriesFeedItemSizeKb) - elif ' str: +def _YTchannelToAtomFeed(url: str) -> str: """Converts a YouTube channel url into an atom feed url """ if 'youtube.com/channel/' not in url: @@ -633,17 +633,17 @@ def getRSS(baseDir: str, domain: str, session, url: str, 'Mozilla/5.0 (X11; Linux x86_64; rv:81.0) Gecko/20100101 Firefox/81.0' if not session: print('WARN: no session specified for getRSS') - url = YTchannelToAtomFeed(url) + url = _YTchannelToAtomFeed(url) try: result = session.get(url, headers=sessionHeaders, params=sessionParams) if result: if int(len(result.text) / 1024) < maxFeedSizeKb and \ not containsInvalidChars(result.text): - return xmlStrToDict(baseDir, domain, result.text, - moderated, mirrored, - maxPostsPerSource, - maxFeedItemSizeKb, - maxCategoriesFeedItemSizeKb) + return _xmlStrToDict(baseDir, domain, result.text, + moderated, mirrored, + maxPostsPerSource, + maxFeedItemSizeKb, + maxCategoriesFeedItemSizeKb) else: print('WARN: feed is too large, ' + 'or contains invalid characters: ' + url) @@ -692,7 +692,7 @@ def getRSSfromDict(baseDir: str, newswire: {}, continue rssStr += '\n' rssStr += ' ' + fields[0] + '\n' - description = removeCDATA(firstParagraphFromString(fields[4])) + description = _removeCDATA(firstParagraphFromString(fields[4])) rssStr += ' ' + description + '\n' url = fields[1] if '://' not in url: @@ -707,7 +707,7 @@ def getRSSfromDict(baseDir: str, newswire: {}, return rssStr -def isNewswireBlogPost(postJsonObject: {}) -> bool: +def _isNewswireBlogPost(postJsonObject: {}) -> bool: """Is the given object a blog post? There isn't any difference between a blog post and a newswire blog post but we may here need to check for different properties than @@ -727,7 +727,7 @@ def isNewswireBlogPost(postJsonObject: {}) -> bool: return False -def getHashtagsFromPost(postJsonObject: {}) -> []: +def _getHashtagsFromPost(postJsonObject: {}) -> []: """Returns a list of any hashtags within a post """ if not postJsonObject.get('object'): @@ -753,11 +753,11 @@ def getHashtagsFromPost(postJsonObject: {}) -> []: return tags -def addAccountBlogsToNewswire(baseDir: str, nickname: str, domain: str, - newswire: {}, - maxBlogsPerAccount: int, - indexFilename: str, - maxTags: int) -> None: +def _addAccountBlogsToNewswire(baseDir: str, nickname: str, domain: str, + newswire: {}, + maxBlogsPerAccount: int, + indexFilename: str, + maxTags: int) -> None: """Adds blogs for the given account to the newswire """ if not os.path.isfile(indexFilename): @@ -803,7 +803,7 @@ def addAccountBlogsToNewswire(baseDir: str, nickname: str, domain: str, postJsonObject = None if fullPostFilename: postJsonObject = loadJson(fullPostFilename) - if isNewswireBlogPost(postJsonObject): + if _isNewswireBlogPost(postJsonObject): published = postJsonObject['object']['published'] published = published.replace('T', ' ') published = published.replace('Z', '+00:00') @@ -812,24 +812,24 @@ def addAccountBlogsToNewswire(baseDir: str, nickname: str, domain: str, votes = loadJson(fullPostFilename + '.votes') content = postJsonObject['object']['content'] description = firstParagraphFromString(content) - description = removeCDATA(description) - addNewswireDictEntry(baseDir, domain, - newswire, published, - postJsonObject['object']['summary'], - postJsonObject['object']['url'], - votes, fullPostFilename, - description, moderated, False, - getHashtagsFromPost(postJsonObject), - maxTags) + description = _removeCDATA(description) + _addNewswireDictEntry(baseDir, domain, + newswire, published, + postJsonObject['object']['summary'], + postJsonObject['object']['url'], + votes, fullPostFilename, + description, moderated, False, + _getHashtagsFromPost(postJsonObject), + maxTags) ctr += 1 if ctr >= maxBlogsPerAccount: break -def addBlogsToNewswire(baseDir: str, domain: str, newswire: {}, - maxBlogsPerAccount: int, - maxTags: int) -> None: +def _addBlogsToNewswire(baseDir: str, domain: str, newswire: {}, + maxBlogsPerAccount: int, + maxTags: int) -> None: """Adds blogs from each user account into the newswire """ moderationDict = {} @@ -857,9 +857,9 @@ def addBlogsToNewswire(baseDir: str, domain: str, newswire: {}, blogsIndex = accountDir + '/tlblogs.index' if os.path.isfile(blogsIndex): domain = handle.split('@')[1] - addAccountBlogsToNewswire(baseDir, nickname, domain, - newswire, maxBlogsPerAccount, - blogsIndex, maxTags) + _addAccountBlogsToNewswire(baseDir, nickname, domain, + newswire, maxBlogsPerAccount, + blogsIndex, maxTags) break # sort the moderation dict into chronological order, latest first @@ -926,8 +926,8 @@ def getDictFromNewswire(session, baseDir: str, domain: str, result[dateStr] = item # add blogs from each user account - addBlogsToNewswire(baseDir, domain, result, - maxPostsPerSource, maxTags) + _addBlogsToNewswire(baseDir, domain, result, + maxPostsPerSource, maxTags) # sort into chronological order, latest first sortedResult = OrderedDict(sorted(result.items(), reverse=True)) diff --git a/person.py b/person.py index 6c847063c..a2b76bd2d 100644 --- a/person.py +++ b/person.py @@ -134,7 +134,7 @@ def setOrganizationScheme(baseDir: str, nickname: str, domain: str, return True -def accountExists(baseDir: str, nickname: str, domain: str) -> bool: +def _accountExists(baseDir: str, nickname: str, domain: str) -> bool: """Returns true if the given account exists """ if ':' in domain: @@ -201,10 +201,10 @@ def getDefaultPersonContext() -> str: } -def createPersonBase(baseDir: str, nickname: str, domain: str, port: int, - httpPrefix: str, saveToFile: bool, - manualFollowerApproval: bool, - password=None) -> (str, str, {}, {}): +def _createPersonBase(baseDir: str, nickname: str, domain: str, port: int, + httpPrefix: str, saveToFile: bool, + manualFollowerApproval: bool, + password=None) -> (str, str, {}, {}): """Returns the private key, public key, actor and webfinger endpoint """ privateKeyPem, publicKeyPem = generateRSAKey() @@ -377,7 +377,7 @@ def registerAccount(baseDir: str, httpPrefix: str, domain: str, port: int, manualFollowerApproval: bool) -> bool: """Registers a new account from the web interface """ - if accountExists(baseDir, nickname, domain): + if _accountExists(baseDir, nickname, domain): return False if not validNickname(domain, nickname): print('REGISTER: Nickname ' + nickname + ' is invalid') @@ -449,12 +449,12 @@ def createPerson(baseDir: str, nickname: str, domain: str, port: int, return None, None, None, None (privateKeyPem, publicKeyPem, - newPerson, webfingerEndpoint) = createPersonBase(baseDir, nickname, - domain, port, - httpPrefix, - saveToFile, - manualFollowerApproval, - password) + newPerson, webfingerEndpoint) = _createPersonBase(baseDir, nickname, + domain, port, + httpPrefix, + saveToFile, + manualFollowerApproval, + password) if not getConfigParam(baseDir, 'admin'): if nickname != 'news': # print(nickname+' becomes the instance admin and a moderator') @@ -525,8 +525,8 @@ def createSharedInbox(baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str) -> (str, str, {}, {}): """Generates the shared inbox """ - return createPersonBase(baseDir, nickname, domain, port, httpPrefix, - True, True, None) + return _createPersonBase(baseDir, nickname, domain, port, httpPrefix, + True, True, None) def createNewsInbox(baseDir: str, domain: str, port: int, @@ -845,8 +845,8 @@ def canRemovePost(baseDir: str, nickname: str, return True -def removeTagsForNickname(baseDir: str, nickname: str, - domain: str, port: int) -> None: +def _removeTagsForNickname(baseDir: str, nickname: str, + domain: str, port: int) -> None: """Removes tags for a nickname """ if not os.path.isdir(baseDir + '/tags'): @@ -900,7 +900,7 @@ def removeAccount(baseDir: str, nickname: str, unsuspendAccount(baseDir, nickname) handle = nickname + '@' + domain removePassword(baseDir, nickname) - removeTagsForNickname(baseDir, nickname, domain, port) + _removeTagsForNickname(baseDir, nickname, domain, port) if os.path.isdir(baseDir + '/deactivated/' + handle): shutil.rmtree(baseDir + '/deactivated/' + handle) if os.path.isdir(baseDir + '/accounts/' + handle): diff --git a/petnames.py b/petnames.py index 7046a5d94..d586deb0e 100644 --- a/petnames.py +++ b/petnames.py @@ -77,8 +77,8 @@ def getPetName(baseDir: str, nickname: str, domain: str, return '' -def getPetNameHandle(baseDir: str, nickname: str, domain: str, - petname: str) -> str: +def _getPetNameHandle(baseDir: str, nickname: str, domain: str, + petname: str) -> str: """Given a petname returns the handle """ if petname.startswith('@'): @@ -113,7 +113,7 @@ def resolvePetnames(baseDir: str, nickname: str, domain: str, if not wrd.startswith('@'): break # does a petname handle exist for this? - handle = getPetNameHandle(baseDir, nickname, domain, wrd) + handle = _getPetNameHandle(baseDir, nickname, domain, wrd) if not handle: continue # replace the petname with the handle diff --git a/posts.py b/posts.py index 647742994..1bb3462a6 100644 --- a/posts.py +++ b/posts.py @@ -116,8 +116,8 @@ def noOfFollowersOnDomain(baseDir: str, handle: str, return ctr -def getPersonKey(nickname: str, domain: str, baseDir: str, keyType='public', - debug=False): +def _getPersonKey(nickname: str, domain: str, baseDir: str, keyType='public', + debug=False): """Returns the public or private key of a person """ handle = nickname + '@' + domain @@ -136,7 +136,7 @@ def getPersonKey(nickname: str, domain: str, baseDir: str, keyType='public', return keyPem -def cleanHtml(rawHtml: str) -> str: +def _cleanHtml(rawHtml: str) -> str: # text=BeautifulSoup(rawHtml, 'html.parser').get_text() text = rawHtml return html.unescape(text) @@ -288,14 +288,14 @@ def getPersonBox(baseDir: str, session, wfRequest: {}, avatarUrl, displayName -def getPosts(session, outboxUrl: str, maxPosts: int, - maxMentions: int, - maxEmoji: int, maxAttachments: int, - federationList: [], - personCache: {}, raw: bool, - simple: bool, debug: bool, - projectVersion: str, httpPrefix: str, - domain: str) -> {}: +def _getPosts(session, outboxUrl: str, maxPosts: int, + maxMentions: int, + maxEmoji: int, maxAttachments: int, + federationList: [], + personCache: {}, raw: bool, + simple: bool, debug: bool, + projectVersion: str, httpPrefix: str, + domain: str) -> {}: """Gets public posts from an outbox """ personPosts = {} @@ -445,7 +445,7 @@ def getPosts(session, outboxUrl: str, maxPosts: int, sensitive = item['object']['sensitive'] if simple: - print(cleanHtml(content) + '\n') + print(_cleanHtml(content) + '\n') else: pprint(item) personPosts[item['id']] = { @@ -453,7 +453,7 @@ def getPosts(session, outboxUrl: str, maxPosts: int, "inreplyto": inReplyTo, "summary": summary, "html": content, - "plaintext": cleanHtml(content), + "plaintext": _cleanHtml(content), "attachment": attachment, "mentions": mentions, "emoji": emoji, @@ -519,15 +519,15 @@ def getPostDomains(session, outboxUrl: str, maxPosts: int, return postDomains -def getPostsForBlockedDomains(baseDir: str, - session, outboxUrl: str, maxPosts: int, - maxMentions: int, - maxEmoji: int, maxAttachments: int, - federationList: [], - personCache: {}, - debug: bool, - projectVersion: str, httpPrefix: str, - domain: str) -> {}: +def _getPostsForBlockedDomains(baseDir: str, + session, outboxUrl: str, maxPosts: int, + maxMentions: int, + maxEmoji: int, maxAttachments: int, + federationList: [], + personCache: {}, + debug: bool, + projectVersion: str, httpPrefix: str, + domain: str) -> {}: """Returns a dictionary of posts for blocked domains """ if not outboxUrl: @@ -643,7 +643,7 @@ def savePostToBox(baseDir: str, httpPrefix: str, postId: str, return filename -def updateHashtagsIndex(baseDir: str, tag: {}, newPostId: str) -> None: +def _updateHashtagsIndex(baseDir: str, tag: {}, newPostId: str) -> None: """Writes the post url for hashtags to a file This allows posts for a hashtag to be quickly looked up """ @@ -677,8 +677,8 @@ def updateHashtagsIndex(baseDir: str, tag: {}, newPostId: str) -> None: tagsFilename + ' ' + str(e)) -def addSchedulePost(baseDir: str, nickname: str, domain: str, - eventDateStr: str, postId: str) -> None: +def _addSchedulePost(baseDir: str, nickname: str, domain: str, + eventDateStr: str, postId: str) -> None: """Adds a scheduled post to the index """ handle = nickname + '@' + domain @@ -703,18 +703,18 @@ def addSchedulePost(baseDir: str, nickname: str, domain: str, scheduleFile.close() -def appendEventFields(newPost: {}, - eventUUID: str, eventStatus: str, - anonymousParticipationEnabled: bool, - repliesModerationOption: str, - category: str, - joinMode: str, - eventDateStr: str, - endDateStr: str, - location: str, - maximumAttendeeCapacity: int, - ticketUrl: str, - subject: str) -> None: +def _appendEventFields(newPost: {}, + eventUUID: str, eventStatus: str, + anonymousParticipationEnabled: bool, + repliesModerationOption: str, + category: str, + joinMode: str, + eventDateStr: str, + endDateStr: str, + location: str, + maximumAttendeeCapacity: int, + ticketUrl: str, + subject: str) -> None: """Appends Mobilizon-type event fields to a post """ if not eventUUID: @@ -758,7 +758,7 @@ def validContentWarning(cw: str) -> str: return cw -def loadAutoCW(baseDir: str, nickname: str, domain: str) -> []: +def _loadAutoCW(baseDir: str, nickname: str, domain: str) -> []: """Loads automatic CWs file and returns a list containing the lines of the file """ @@ -771,13 +771,13 @@ def loadAutoCW(baseDir: str, nickname: str, domain: str) -> []: return [] -def addAutoCW(baseDir: str, nickname: str, domain: str, - subject: str, content: str) -> str: +def _addAutoCW(baseDir: str, nickname: str, domain: str, + subject: str, content: str) -> str: """Appends any automatic CW to the subject line and returns the new subject line """ newSubject = subject - autoCWList = loadAutoCW(baseDir, nickname, domain) + autoCWList = _loadAutoCW(baseDir, nickname, domain) for cwRule in autoCWList: if '->' not in cwRule: continue @@ -793,26 +793,26 @@ def addAutoCW(baseDir: str, nickname: str, domain: str, return newSubject -def createPostBase(baseDir: str, nickname: str, domain: str, port: int, - toUrl: str, ccUrl: str, httpPrefix: str, content: str, - followersOnly: bool, saveToFile: bool, clientToServer: bool, - commentsEnabled: bool, - attachImageFilename: str, - mediaType: str, imageDescription: str, - useBlurhash: bool, isModerationReport: bool, - isArticle: bool, - inReplyTo=None, - inReplyToAtomUri=None, subject=None, schedulePost=False, - eventDate=None, eventTime=None, location=None, - eventUUID=None, category=None, joinMode=None, - endDate=None, endTime=None, - maximumAttendeeCapacity=None, - repliesModerationOption=None, - anonymousParticipationEnabled=None, - eventStatus=None, ticketUrl=None) -> {}: +def _createPostBase(baseDir: str, nickname: str, domain: str, port: int, + toUrl: str, ccUrl: str, httpPrefix: str, content: str, + followersOnly: bool, saveToFile: bool, + clientToServer: bool, commentsEnabled: bool, + attachImageFilename: str, + mediaType: str, imageDescription: str, + useBlurhash: bool, isModerationReport: bool, + isArticle: bool, + inReplyTo=None, + inReplyToAtomUri=None, subject=None, schedulePost=False, + eventDate=None, eventTime=None, location=None, + eventUUID=None, category=None, joinMode=None, + endDate=None, endTime=None, + maximumAttendeeCapacity=None, + repliesModerationOption=None, + anonymousParticipationEnabled=None, + eventStatus=None, ticketUrl=None) -> {}: """Creates a message """ - subject = addAutoCW(baseDir, nickname, domain, subject, content) + subject = _addAutoCW(baseDir, nickname, domain, subject, content) if nickname != 'news': mentionedRecipients = \ @@ -885,7 +885,7 @@ def createPostBase(baseDir: str, nickname: str, domain: str, port: int, if not tagExists(tag['type'], tag['name'], tags): tags.append(tag) if isPublic: - updateHashtagsIndex(baseDir, tag, newPostId) + _updateHashtagsIndex(baseDir, tag, newPostId) print('Content tags: ' + str(tags)) if inReplyTo and not sensitive: @@ -1031,13 +1031,13 @@ def createPostBase(baseDir: str, nickname: str, domain: str, port: int, attachMedia(baseDir, httpPrefix, domain, port, newPost['object'], attachImageFilename, mediaType, imageDescription, useBlurhash) - appendEventFields(newPost['object'], eventUUID, eventStatus, - anonymousParticipationEnabled, - repliesModerationOption, - category, joinMode, - eventDateStr, endDateStr, - location, maximumAttendeeCapacity, - ticketUrl, subject) + _appendEventFields(newPost['object'], eventUUID, eventStatus, + anonymousParticipationEnabled, + repliesModerationOption, + category, joinMode, + eventDateStr, endDateStr, + location, maximumAttendeeCapacity, + ticketUrl, subject) else: idStr = \ httpPrefix + '://' + domain + '/users/' + nickname + \ @@ -1079,13 +1079,13 @@ def createPostBase(baseDir: str, nickname: str, domain: str, port: int, attachMedia(baseDir, httpPrefix, domain, port, newPost, attachImageFilename, mediaType, imageDescription, useBlurhash) - appendEventFields(newPost, eventUUID, eventStatus, - anonymousParticipationEnabled, - repliesModerationOption, - category, joinMode, - eventDateStr, endDateStr, - location, maximumAttendeeCapacity, - ticketUrl, subject) + _appendEventFields(newPost, eventUUID, eventStatus, + anonymousParticipationEnabled, + repliesModerationOption, + category, joinMode, + eventDateStr, endDateStr, + location, maximumAttendeeCapacity, + ticketUrl, subject) if ccUrl: if len(ccUrl) > 0: newPost['cc'] = [ccUrl] @@ -1123,7 +1123,8 @@ def createPostBase(baseDir: str, nickname: str, domain: str, port: int, if schedulePost: if eventDate and eventTime: # add an item to the scheduled post index file - addSchedulePost(baseDir, nickname, domain, eventDateStr, newPostId) + _addSchedulePost(baseDir, nickname, domain, + eventDateStr, newPostId) savePostToBox(baseDir, httpPrefix, newPostId, nickname, domain, newPost, 'scheduled') else: @@ -1179,10 +1180,10 @@ def outboxMessageCreateWrap(httpPrefix: str, return newPost -def postIsAddressedToFollowers(baseDir: str, - nickname: str, domain: str, port: int, - httpPrefix: str, - postJsonObject: {}) -> bool: +def _postIsAddressedToFollowers(baseDir: str, + nickname: str, domain: str, port: int, + httpPrefix: str, + postJsonObject: {}) -> bool: """Returns true if the given post is addressed to followers of the nickname """ domainFull = getFullDomain(domain, port) @@ -1227,18 +1228,18 @@ def createPublicPost(baseDir: str, """Public post """ domainFull = getFullDomain(domain, port) - return createPostBase(baseDir, nickname, domain, port, - 'https://www.w3.org/ns/activitystreams#Public', - httpPrefix + '://' + domainFull + '/users/' + - nickname + '/followers', - httpPrefix, content, followersOnly, saveToFile, - clientToServer, commentsEnabled, - attachImageFilename, mediaType, - imageDescription, useBlurhash, - False, False, inReplyTo, inReplyToAtomUri, subject, - schedulePost, eventDate, eventTime, location, - None, None, None, None, None, - None, None, None, None, None) + return _createPostBase(baseDir, nickname, domain, port, + 'https://www.w3.org/ns/activitystreams#Public', + httpPrefix + '://' + domainFull + '/users/' + + nickname + '/followers', + httpPrefix, content, followersOnly, saveToFile, + clientToServer, commentsEnabled, + attachImageFilename, mediaType, + imageDescription, useBlurhash, + False, False, inReplyTo, inReplyToAtomUri, subject, + schedulePost, eventDate, eventTime, location, + None, None, None, None, None, + None, None, None, None, None) def createBlogPost(baseDir: str, @@ -1328,18 +1329,18 @@ def createQuestionPost(baseDir: str, """ domainFull = getFullDomain(domain, port) messageJson = \ - createPostBase(baseDir, nickname, domain, port, - 'https://www.w3.org/ns/activitystreams#Public', - httpPrefix + '://' + domainFull + '/users/' + - nickname + '/followers', - httpPrefix, content, followersOnly, saveToFile, - clientToServer, commentsEnabled, - attachImageFilename, mediaType, - imageDescription, useBlurhash, - False, False, None, None, subject, - False, None, None, None, None, None, - None, None, None, - None, None, None, None, None) + _createPostBase(baseDir, nickname, domain, port, + 'https://www.w3.org/ns/activitystreams#Public', + httpPrefix + '://' + domainFull + '/users/' + + nickname + '/followers', + httpPrefix, content, followersOnly, saveToFile, + clientToServer, commentsEnabled, + attachImageFilename, mediaType, + imageDescription, useBlurhash, + False, False, None, None, subject, + False, None, None, None, None, None, + None, None, None, + None, None, None, None, None) messageJson['object']['type'] = 'Question' messageJson['object']['oneOf'] = [] messageJson['object']['votersCount'] = 0 @@ -1373,18 +1374,18 @@ def createUnlistedPost(baseDir: str, """Unlisted post. This has the #Public and followers links inverted. """ domainFull = getFullDomain(domain, port) - return createPostBase(baseDir, nickname, domain, port, - httpPrefix + '://' + domainFull + '/users/' + - nickname + '/followers', - 'https://www.w3.org/ns/activitystreams#Public', - httpPrefix, content, followersOnly, saveToFile, - clientToServer, commentsEnabled, - attachImageFilename, mediaType, - imageDescription, useBlurhash, - False, False, inReplyTo, inReplyToAtomUri, subject, - schedulePost, eventDate, eventTime, location, - None, None, None, None, None, - None, None, None, None, None) + return _createPostBase(baseDir, nickname, domain, port, + httpPrefix + '://' + domainFull + '/users/' + + nickname + '/followers', + 'https://www.w3.org/ns/activitystreams#Public', + httpPrefix, content, followersOnly, saveToFile, + clientToServer, commentsEnabled, + attachImageFilename, mediaType, + imageDescription, useBlurhash, + False, False, inReplyTo, inReplyToAtomUri, subject, + schedulePost, eventDate, eventTime, location, + None, None, None, None, None, + None, None, None, None, None) def createFollowersOnlyPost(baseDir: str, @@ -1402,18 +1403,18 @@ def createFollowersOnlyPost(baseDir: str, """Followers only post """ domainFull = getFullDomain(domain, port) - return createPostBase(baseDir, nickname, domain, port, - httpPrefix + '://' + domainFull + '/users/' + - nickname + '/followers', - None, - httpPrefix, content, followersOnly, saveToFile, - clientToServer, commentsEnabled, - attachImageFilename, mediaType, - imageDescription, useBlurhash, - False, False, inReplyTo, inReplyToAtomUri, subject, - schedulePost, eventDate, eventTime, location, - None, None, None, None, None, - None, None, None, None, None) + return _createPostBase(baseDir, nickname, domain, port, + httpPrefix + '://' + domainFull + '/users/' + + nickname + '/followers', + None, + httpPrefix, content, followersOnly, saveToFile, + clientToServer, commentsEnabled, + attachImageFilename, mediaType, + imageDescription, useBlurhash, + False, False, inReplyTo, inReplyToAtomUri, subject, + schedulePost, eventDate, eventTime, location, + None, None, None, None, None, + None, None, None, None, None) def createEventPost(baseDir: str, @@ -1451,19 +1452,19 @@ def createEventPost(baseDir: str, if followersOnly: toStr1 = toStr2 toStr2 = None - return createPostBase(baseDir, nickname, domain, port, - toStr1, toStr2, - httpPrefix, content, followersOnly, saveToFile, - clientToServer, commentsEnabled, - attachImageFilename, mediaType, - imageDescription, useBlurhash, - False, False, None, None, subject, - schedulePost, eventDate, eventTime, location, - eventUUID, category, joinMode, - endDate, endTime, maximumAttendeeCapacity, - repliesModerationOption, - anonymousParticipationEnabled, - eventStatus, ticketUrl) + return _createPostBase(baseDir, nickname, domain, port, + toStr1, toStr2, + httpPrefix, content, followersOnly, saveToFile, + clientToServer, commentsEnabled, + attachImageFilename, mediaType, + imageDescription, useBlurhash, + False, False, None, None, subject, + schedulePost, eventDate, eventTime, location, + eventUUID, category, joinMode, + endDate, endTime, maximumAttendeeCapacity, + repliesModerationOption, + anonymousParticipationEnabled, + eventStatus, ticketUrl) def getMentionedPeople(baseDir: str, httpPrefix: str, @@ -1526,16 +1527,16 @@ def createDirectMessagePost(baseDir: str, postTo = None postCc = None messageJson = \ - createPostBase(baseDir, nickname, domain, port, - postTo, postCc, - httpPrefix, content, followersOnly, saveToFile, - clientToServer, commentsEnabled, - attachImageFilename, mediaType, - imageDescription, useBlurhash, - False, False, inReplyTo, inReplyToAtomUri, subject, - schedulePost, eventDate, eventTime, location, - None, None, None, None, None, - None, None, None, None, None) + _createPostBase(baseDir, nickname, domain, port, + postTo, postCc, + httpPrefix, content, followersOnly, saveToFile, + clientToServer, commentsEnabled, + attachImageFilename, mediaType, + imageDescription, useBlurhash, + False, False, inReplyTo, inReplyToAtomUri, subject, + schedulePost, eventDate, eventTime, location, + None, None, None, None, None, + None, None, None, None, None) # mentioned recipients go into To rather than Cc messageJson['to'] = messageJson['object']['cc'] messageJson['object']['to'] = messageJson['to'] @@ -1616,16 +1617,16 @@ def createReportPost(baseDir: str, handle = toNickname + '@' + domain postJsonObject = \ - createPostBase(baseDir, nickname, domain, port, - toUrl, postCc, - httpPrefix, content, followersOnly, saveToFile, - clientToServer, commentsEnabled, - attachImageFilename, mediaType, - imageDescription, useBlurhash, - True, False, None, None, subject, - False, None, None, None, None, None, - None, None, None, - None, None, None, None, None) + _createPostBase(baseDir, nickname, domain, port, + toUrl, postCc, + httpPrefix, content, followersOnly, saveToFile, + clientToServer, commentsEnabled, + attachImageFilename, mediaType, + imageDescription, useBlurhash, + True, False, None, None, subject, + False, None, None, None, None, None, + None, None, None, + None, None, None, None, None) if not postJsonObject: continue @@ -1766,20 +1767,20 @@ def sendPost(projectVersion: str, # sharedInbox is optional postJsonObject = \ - createPostBase(baseDir, nickname, domain, port, - toPersonId, cc, httpPrefix, content, - followersOnly, saveToFile, clientToServer, - commentsEnabled, - attachImageFilename, mediaType, - imageDescription, useBlurhash, - False, isArticle, inReplyTo, - inReplyToAtomUri, subject, - False, None, None, None, None, None, - None, None, None, - None, None, None, None, None) + _createPostBase(baseDir, nickname, domain, port, + toPersonId, cc, httpPrefix, content, + followersOnly, saveToFile, clientToServer, + commentsEnabled, + attachImageFilename, mediaType, + imageDescription, useBlurhash, + False, isArticle, inReplyTo, + inReplyToAtomUri, subject, + False, None, None, None, None, None, + None, None, None, + None, None, None, None, None) # get the senders private key - privateKeyPem = getPersonKey(nickname, domain, baseDir, 'private') + privateKeyPem = _getPersonKey(nickname, domain, baseDir, 'private') if len(privateKeyPem) == 0: return 6 @@ -1902,18 +1903,18 @@ def sendPostViaServer(projectVersion: str, '/users/' + toNickname postJsonObject = \ - createPostBase(baseDir, - fromNickname, fromDomain, fromPort, - toPersonId, cc, httpPrefix, content, - followersOnly, saveToFile, clientToServer, - commentsEnabled, - attachImageFilename, mediaType, - imageDescription, useBlurhash, - False, isArticle, inReplyTo, - inReplyToAtomUri, subject, - False, None, None, None, None, None, - None, None, None, - None, None, None, None, None) + _createPostBase(baseDir, + fromNickname, fromDomain, fromPort, + toPersonId, cc, httpPrefix, content, + followersOnly, saveToFile, clientToServer, + commentsEnabled, + attachImageFilename, mediaType, + imageDescription, useBlurhash, + False, isArticle, inReplyTo, + inReplyToAtomUri, subject, + False, None, None, None, None, None, + None, None, None, + None, None, None, None, None) authHeader = createBasicAuthHeader(fromNickname, password) @@ -1969,7 +1970,7 @@ def groupFollowersByDomain(baseDir: str, nickname: str, domain: str) -> {}: return grouped -def addFollowersToPublicPost(postJsonObject: {}) -> None: +def _addFollowersToPublicPost(postJsonObject: {}) -> None: """Adds followers entry to cc if it doesn't exist """ if not postJsonObject.get('actor'): @@ -2099,7 +2100,7 @@ def sendSignedJson(postJsonObject: {}, session, baseDir: str, # sharedInbox is optional # get the senders private key - privateKeyPem = getPersonKey(nickname, domain, baseDir, 'private', debug) + privateKeyPem = _getPersonKey(nickname, domain, baseDir, 'private', debug) if len(privateKeyPem) == 0: if debug: print('DEBUG: Private key not found for ' + @@ -2112,7 +2113,7 @@ def sendSignedJson(postJsonObject: {}, session, baseDir: str, return 7 postPath = inboxUrl.split(toDomain, 1)[1] - addFollowersToPublicPost(postJsonObject) + _addFollowersToPublicPost(postJsonObject) if not postJsonObject.get('signature'): try: @@ -2332,7 +2333,7 @@ def sendToNamedAddresses(session, baseDir: str, personCache, debug, projectVersion) -def hasSharedInbox(session, httpPrefix: str, domain: str) -> bool: +def _hasSharedInbox(session, httpPrefix: str, domain: str) -> bool: """Returns true if the given domain has a shared inbox This tries the new and the old way of webfingering the shared inbox """ @@ -2351,7 +2352,7 @@ def hasSharedInbox(session, httpPrefix: str, domain: str) -> bool: return False -def sendingProfileUpdate(postJsonObject: {}) -> bool: +def _sendingProfileUpdate(postJsonObject: {}) -> bool: """Returns true if the given json is a profile update """ if postJsonObject['type'] != 'Update': @@ -2386,9 +2387,9 @@ def sendToFollowers(session, baseDir: str, if not session: print('WARN: No session for sendToFollowers') return - if not postIsAddressedToFollowers(baseDir, nickname, domain, - port, httpPrefix, - postJsonObject): + if not _postIsAddressedToFollowers(baseDir, nickname, domain, + port, httpPrefix, + postJsonObject): if debug: print('Post is not addressed to followers') return @@ -2428,7 +2429,7 @@ def sendToFollowers(session, baseDir: str, print('Sending post to followers domain is active: ' + followerDomainUrl) - withSharedInbox = hasSharedInbox(session, httpPrefix, followerDomain) + withSharedInbox = _hasSharedInbox(session, httpPrefix, followerDomain) if debug: if withSharedInbox: print(followerDomain + ' has shared inbox') @@ -2467,7 +2468,7 @@ def sendToFollowers(session, baseDir: str, toNickname = 'inbox' if toNickname != 'inbox' and postJsonObject.get('type'): - if sendingProfileUpdate(postJsonObject): + if _sendingProfileUpdate(postJsonObject): print('Sending post to followers ' + 'shared inbox of ' + toDomain) toNickname = 'inbox' @@ -2554,77 +2555,77 @@ def createInbox(recentPostsCache: {}, session, baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str, itemsPerPage: int, headerOnly: bool, pageNumber=None) -> {}: - return createBoxIndexed(recentPostsCache, - session, baseDir, 'inbox', - nickname, domain, port, httpPrefix, - itemsPerPage, headerOnly, True, - 0, False, 0, pageNumber) + return _createBoxIndexed(recentPostsCache, + session, baseDir, 'inbox', + nickname, domain, port, httpPrefix, + itemsPerPage, headerOnly, True, + 0, False, 0, pageNumber) def createBookmarksTimeline(session, baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str, itemsPerPage: int, headerOnly: bool, pageNumber=None) -> {}: - return createBoxIndexed({}, session, baseDir, 'tlbookmarks', - nickname, domain, - port, httpPrefix, itemsPerPage, headerOnly, - True, 0, False, 0, pageNumber) + return _createBoxIndexed({}, session, baseDir, 'tlbookmarks', + nickname, domain, + port, httpPrefix, itemsPerPage, headerOnly, + True, 0, False, 0, pageNumber) def createEventsTimeline(recentPostsCache: {}, session, baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str, itemsPerPage: int, headerOnly: bool, pageNumber=None) -> {}: - return createBoxIndexed(recentPostsCache, session, baseDir, 'tlevents', - nickname, domain, - port, httpPrefix, itemsPerPage, headerOnly, - True, 0, False, 0, pageNumber) + return _createBoxIndexed(recentPostsCache, session, baseDir, 'tlevents', + nickname, domain, + port, httpPrefix, itemsPerPage, headerOnly, + True, 0, False, 0, pageNumber) def createDMTimeline(recentPostsCache: {}, session, baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str, itemsPerPage: int, headerOnly: bool, pageNumber=None) -> {}: - return createBoxIndexed(recentPostsCache, - session, baseDir, 'dm', nickname, - domain, port, httpPrefix, itemsPerPage, - headerOnly, True, 0, False, 0, pageNumber) + return _createBoxIndexed(recentPostsCache, + session, baseDir, 'dm', nickname, + domain, port, httpPrefix, itemsPerPage, + headerOnly, True, 0, False, 0, pageNumber) def createRepliesTimeline(recentPostsCache: {}, session, baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str, itemsPerPage: int, headerOnly: bool, pageNumber=None) -> {}: - return createBoxIndexed(recentPostsCache, session, baseDir, 'tlreplies', - nickname, domain, port, httpPrefix, - itemsPerPage, headerOnly, True, - 0, False, 0, pageNumber) + return _createBoxIndexed(recentPostsCache, session, baseDir, 'tlreplies', + nickname, domain, port, httpPrefix, + itemsPerPage, headerOnly, True, + 0, False, 0, pageNumber) def createBlogsTimeline(session, baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str, itemsPerPage: int, headerOnly: bool, pageNumber=None) -> {}: - return createBoxIndexed({}, session, baseDir, 'tlblogs', nickname, - domain, port, httpPrefix, - itemsPerPage, headerOnly, True, - 0, False, 0, pageNumber) + return _createBoxIndexed({}, session, baseDir, 'tlblogs', nickname, + domain, port, httpPrefix, + itemsPerPage, headerOnly, True, + 0, False, 0, pageNumber) def createFeaturesTimeline(session, baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str, itemsPerPage: int, headerOnly: bool, pageNumber=None) -> {}: - return createBoxIndexed({}, session, baseDir, 'tlfeatures', nickname, - domain, port, httpPrefix, - itemsPerPage, headerOnly, True, - 0, False, 0, pageNumber) + return _createBoxIndexed({}, session, baseDir, 'tlfeatures', nickname, + domain, port, httpPrefix, + itemsPerPage, headerOnly, True, + 0, False, 0, pageNumber) def createMediaTimeline(session, baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str, itemsPerPage: int, headerOnly: bool, pageNumber=None) -> {}: - return createBoxIndexed({}, session, baseDir, 'tlmedia', nickname, - domain, port, httpPrefix, - itemsPerPage, headerOnly, True, - 0, False, 0, pageNumber) + return _createBoxIndexed({}, session, baseDir, 'tlmedia', nickname, + domain, port, httpPrefix, + itemsPerPage, headerOnly, True, + 0, False, 0, pageNumber) def createNewsTimeline(session, baseDir: str, nickname: str, domain: str, @@ -2632,21 +2633,21 @@ def createNewsTimeline(session, baseDir: str, nickname: str, domain: str, headerOnly: bool, newswireVotesThreshold: int, positiveVoting: bool, votingTimeMins: int, pageNumber=None) -> {}: - return createBoxIndexed({}, session, baseDir, 'outbox', 'news', - domain, port, httpPrefix, - itemsPerPage, headerOnly, True, - newswireVotesThreshold, positiveVoting, - votingTimeMins, pageNumber) + return _createBoxIndexed({}, session, baseDir, 'outbox', 'news', + domain, port, httpPrefix, + itemsPerPage, headerOnly, True, + newswireVotesThreshold, positiveVoting, + votingTimeMins, pageNumber) def createOutbox(session, baseDir: str, nickname: str, domain: str, port: int, httpPrefix: str, itemsPerPage: int, headerOnly: bool, authorized: bool, pageNumber=None) -> {}: - return createBoxIndexed({}, session, baseDir, 'outbox', - nickname, domain, port, httpPrefix, - itemsPerPage, headerOnly, authorized, - 0, False, 0, pageNumber) + return _createBoxIndexed({}, session, baseDir, 'outbox', + nickname, domain, port, httpPrefix, + itemsPerPage, headerOnly, authorized, + 0, False, 0, pageNumber) def createModeration(baseDir: str, nickname: str, domain: str, port: int, @@ -2816,8 +2817,8 @@ def isReply(postJsonObject: {}, actor: str) -> bool: return False -def addPostStringToTimeline(postStr: str, boxname: str, - postsInBox: [], boxActor: str) -> bool: +def _addPostStringToTimeline(postStr: str, boxname: str, + postsInBox: [], boxActor: str) -> bool: """ is this a valid timeline post? """ # must be a recognized ActivityPub type @@ -2853,8 +2854,8 @@ def addPostStringToTimeline(postStr: str, boxname: str, return False -def addPostToTimeline(filePath: str, boxname: str, - postsInBox: [], boxActor: str) -> bool: +def _addPostToTimeline(filePath: str, boxname: str, + postsInBox: [], boxActor: str) -> bool: """ Reads a post from file and decides whether it is valid """ with open(filePath, 'r') as postFile: @@ -2866,16 +2867,16 @@ def addPostToTimeline(filePath: str, boxname: str, # append a replies identifier, which will later be removed postStr += '' - return addPostStringToTimeline(postStr, boxname, postsInBox, boxActor) + return _addPostStringToTimeline(postStr, boxname, postsInBox, boxActor) return False -def createBoxIndexed(recentPostsCache: {}, - session, baseDir: str, boxname: str, - nickname: str, domain: str, port: int, httpPrefix: str, - itemsPerPage: int, headerOnly: bool, authorized: bool, - newswireVotesThreshold: int, positiveVoting: bool, - votingTimeMins: int, pageNumber=None) -> {}: +def _createBoxIndexed(recentPostsCache: {}, + session, baseDir: str, boxname: str, + nickname: str, domain: str, port: int, httpPrefix: str, + itemsPerPage: int, headerOnly: bool, authorized: bool, + newswireVotesThreshold: int, positiveVoting: bool, + votingTimeMins: int, pageNumber=None) -> {}: """Constructs the box feed for a person with the given nickname """ if not authorized or not pageNumber: @@ -3006,9 +3007,9 @@ def createBoxIndexed(recentPostsCache: {}, if postUrl in recentPostsCache['index']: if recentPostsCache['json'].get(postUrl): url = recentPostsCache['json'][postUrl] - addPostStringToTimeline(url, - boxname, postsInBox, - boxActor) + _addPostStringToTimeline(url, + boxname, postsInBox, + boxActor) postsCtr += 1 continue @@ -3017,8 +3018,8 @@ def createBoxIndexed(recentPostsCache: {}, locatePost(baseDir, nickname, domain, postUrl, False) if fullPostFilename: - addPostToTimeline(fullPostFilename, boxname, - postsInBox, boxActor) + _addPostToTimeline(fullPostFilename, boxname, + postsInBox, boxActor) else: # if this is the features timeline if timelineNickname != nickname: @@ -3026,8 +3027,8 @@ def createBoxIndexed(recentPostsCache: {}, locatePost(baseDir, timelineNickname, domain, postUrl, False) if fullPostFilename: - addPostToTimeline(fullPostFilename, boxname, - postsInBox, boxActor) + _addPostToTimeline(fullPostFilename, boxname, + postsInBox, boxActor) else: print('WARN: unable to locate post ' + postUrl) else: @@ -3314,10 +3315,10 @@ def getPublicPostsOfPerson(baseDir: str, nickname: str, domain: str, maxMentions = 10 maxEmoji = 10 maxAttachments = 5 - getPosts(session, personUrl, 30, maxMentions, maxEmoji, - maxAttachments, federationList, - personCache, raw, simple, debug, - projectVersion, httpPrefix, domain) + _getPosts(session, personUrl, 30, maxMentions, maxEmoji, + maxAttachments, federationList, + personCache, raw, simple, debug, + projectVersion, httpPrefix, domain) def getPublicPostDomains(session, baseDir: str, nickname: str, domain: str, @@ -3413,14 +3414,14 @@ def getPublicPostInfo(session, baseDir: str, nickname: str, domain: str, domainsInfo[d] = [] blockedPosts = \ - getPostsForBlockedDomains(baseDir, session, personUrl, maxPosts, - maxMentions, - maxEmoji, maxAttachments, - federationList, - personCache, - debug, - projectVersion, httpPrefix, - domain) + _getPostsForBlockedDomains(baseDir, session, personUrl, maxPosts, + maxMentions, + maxEmoji, maxAttachments, + federationList, + personCache, + debug, + projectVersion, httpPrefix, + domain) for blockedDomain, postUrlList in blockedPosts.items(): domainsInfo[blockedDomain] += postUrlList @@ -3467,8 +3468,8 @@ def getPublicPostDomainsBlocked(session, baseDir: str, return blockedDomains -def getNonMutualsOfPerson(baseDir: str, - nickname: str, domain: str) -> []: +def _getNonMutualsOfPerson(baseDir: str, + nickname: str, domain: str) -> []: """Returns the followers who are not mutuals of a person i.e. accounts which follow you but you don't follow them """ @@ -3490,7 +3491,7 @@ def checkDomains(session, baseDir: str, maxBlockedDomains: int, singleCheck: bool): """Checks follower accounts for references to globally blocked domains """ - nonMutuals = getNonMutualsOfPerson(baseDir, nickname, domain) + nonMutuals = _getNonMutualsOfPerson(baseDir, nickname, domain) if not nonMutuals: print('No non-mutual followers were found') return @@ -3614,7 +3615,7 @@ def populateRepliesJson(baseDir: str, nickname: str, domain: str, repliesJson['orderedItems'].append(pjo) -def rejectAnnounce(announceFilename: str): +def _rejectAnnounce(announceFilename: str): """Marks an announce as rejected """ if not os.path.isfile(announceFilename + '.reject'): @@ -3699,40 +3700,40 @@ def downloadAnnounce(session, baseDir: str, httpPrefix: str, if not isinstance(announcedJson, dict): print('WARN: announce json is not a dict - ' + postJsonObject['object']) - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) return None if not announcedJson.get('id'): - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) return None if '/statuses/' not in announcedJson['id']: - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) return None if '/users/' not in announcedJson['id'] and \ '/accounts/' not in announcedJson['id'] and \ '/channel/' not in announcedJson['id'] and \ '/profile/' not in announcedJson['id']: - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) return None if not announcedJson.get('type'): - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) # pprint(announcedJson) return None if announcedJson['type'] != 'Note' and \ announcedJson['type'] != 'Article': - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) # pprint(announcedJson) return None if not announcedJson.get('content'): - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) return None if not announcedJson.get('published'): - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) return None if not validPostDate(announcedJson['published']): - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) return None if isFiltered(baseDir, nickname, domain, announcedJson['content']): - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) return None # remove any long words announcedJson['content'] = \ @@ -3748,7 +3749,7 @@ def downloadAnnounce(session, baseDir: str, httpPrefix: str, actorNickname, actorDomain, actorPort, announcedJson) if announcedJson['type'] != 'Create': - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) # pprint(announcedJson) return None @@ -3765,7 +3766,7 @@ def downloadAnnounce(session, baseDir: str, httpPrefix: str, attributedDomain = getFullDomain(attributedDomain, attributedPort) if isBlocked(baseDir, nickname, domain, attributedNickname, attributedDomain): - rejectAnnounce(announceFilename) + _rejectAnnounce(announceFilename) return None postJsonObject = announcedJson replaceYouTube(postJsonObject, YTReplacementDomain) diff --git a/roles.py b/roles.py index a03a34ba7..459a53b24 100644 --- a/roles.py +++ b/roles.py @@ -63,7 +63,7 @@ def clearEditorStatus(baseDir: str) -> None: saveJson(actorJson, filename) -def addModerator(baseDir: str, nickname: str, domain: str) -> None: +def _addModerator(baseDir: str, nickname: str, domain: str) -> None: """Adds a moderator nickname to the file """ if ':' in domain: @@ -92,7 +92,7 @@ def addModerator(baseDir: str, nickname: str, domain: str) -> None: f.write(nickname + '\n') -def removeModerator(baseDir: str, nickname: str): +def _removeModerator(baseDir: str, nickname: str): """Removes a moderator nickname from the file """ moderatorsFile = baseDir + '/accounts/moderators.txt' @@ -125,7 +125,7 @@ def setRole(baseDir: str, nickname: str, domain: str, if role: # add the role if project == 'instance' and 'role' == 'moderator': - addModerator(baseDir, nickname, domain) + _addModerator(baseDir, nickname, domain) if actorJson['roles'].get(project): if role not in actorJson['roles'][project]: actorJson['roles'][project].append(role) @@ -134,7 +134,7 @@ def setRole(baseDir: str, nickname: str, domain: str, else: # remove the role if project == 'instance': - removeModerator(baseDir, nickname) + _removeModerator(baseDir, nickname) if actorJson['roles'].get(project): actorJson['roles'][project].remove(role) # if the project contains no roles then remove it @@ -144,8 +144,8 @@ def setRole(baseDir: str, nickname: str, domain: str, return True -def getRoles(baseDir: str, nickname: str, domain: str, - project: str) -> []: +def _getRoles(baseDir: str, nickname: str, domain: str, + project: str) -> []: """Returns the roles for a given person on a given project """ actorFilename = baseDir + '/accounts/' + \ @@ -198,8 +198,8 @@ def outboxDelegate(baseDir: str, authenticatedNickname: str, # instance delegators can delagate to other projects # than their own canDelegate = False - delegatorRoles = getRoles(baseDir, delegatorNickname, - domain, 'instance') + delegatorRoles = _getRoles(baseDir, delegatorNickname, + domain, 'instance') if delegatorRoles: if 'delegator' in delegatorRoles: canDelegate = True @@ -207,8 +207,8 @@ def outboxDelegate(baseDir: str, authenticatedNickname: str, if not canDelegate: canDelegate = True # non-instance delegators can only delegate within their project - delegatorRoles = getRoles(baseDir, delegatorNickname, - domain, project) + delegatorRoles = _getRoles(baseDir, delegatorNickname, + domain, project) if delegatorRoles: if 'delegator' not in delegatorRoles: return False @@ -230,7 +230,7 @@ def outboxDelegate(baseDir: str, authenticatedNickname: str, return True # what roles is this person already assigned to? - existingRoles = getRoles(baseDir, nickname, domain, project) + existingRoles = _getRoles(baseDir, nickname, domain, project) if existingRoles: if role in existingRoles: if debug: diff --git a/schedule.py b/schedule.py index 29808ca23..0cf8797ca 100644 --- a/schedule.py +++ b/schedule.py @@ -14,8 +14,8 @@ from utils import loadJson from outbox import postMessageToOutbox -def updatePostSchedule(baseDir: str, handle: str, httpd, - maxScheduledPosts: int) -> None: +def _updatePostSchedule(baseDir: str, handle: str, httpd, + maxScheduledPosts: int) -> None: """Checks if posts are due to be delivered and if so moves them to the outbox """ scheduleIndexFilename = baseDir + '/accounts/' + handle + '/schedule.index' @@ -145,7 +145,7 @@ def runPostSchedule(baseDir: str, httpd, maxScheduledPosts: int): baseDir + '/accounts/' + account + '/schedule.index' if not os.path.isfile(scheduleIndexFilename): continue - updatePostSchedule(baseDir, account, httpd, maxScheduledPosts) + _updatePostSchedule(baseDir, account, httpd, maxScheduledPosts) break diff --git a/shares.py b/shares.py index cb0867cba..d106c32a6 100644 --- a/shares.py +++ b/shares.py @@ -176,11 +176,11 @@ def expireShares(baseDir: str) -> None: continue nickname = account.split('@')[0] domain = account.split('@')[1] - expireSharesForAccount(baseDir, nickname, domain) + _expireSharesForAccount(baseDir, nickname, domain) break -def expireSharesForAccount(baseDir: str, nickname: str, domain: str) -> None: +def _expireSharesForAccount(baseDir: str, nickname: str, domain: str) -> None: """Removes expired items from shares for a particular account """ handleDomain = domain diff --git a/tests.py b/tests.py index 461d03323..945032a6f 100644 --- a/tests.py +++ b/tests.py @@ -101,7 +101,7 @@ thrBob = None thrEve = None -def testHttpsigBase(withDigest): +def _testHttpsigBase(withDigest): print('testHttpsig(' + str(withDigest) + ')') baseDir = os.getcwd() @@ -206,8 +206,8 @@ def testHttpsigBase(withDigest): def testHttpsig(): - testHttpsigBase(True) - testHttpsigBase(False) + _testHttpsigBase(True) + _testHttpsigBase(False) def testCache(): @@ -2617,6 +2617,11 @@ def testFunctions(): excludeImports = [ 'link' ] + excludeLocal = [ + 'pyjsonld', + 'daemon', + 'tests' + ] # check that functions are called somewhere for name, properties in functionProperties.items(): if name in exclusions: @@ -2626,6 +2631,16 @@ def testFunctions(): ' in module ' + properties['module'] + ' is not called anywhere') assert properties['calledInModule'] + + if len(properties['calledInModule']) == 1: + modName = properties['calledInModule'][0] + if modName not in excludeLocal and \ + modName == properties['module']: + if not name.startswith('_'): + print('Local function ' + name + + ' in ' + modName + ' does not begin with _') + assert False + if name not in excludeImports: for modName in properties['calledInModule']: if modName == properties['module']: @@ -2635,8 +2650,6 @@ def testFunctions(): print(importStr + ' not found in ' + modName + '.py') assert False print('Function: ' + name + ' ✓') - # print(str(function)) - # print(str(functionProperties)) def runAllTests(): diff --git a/theme.py b/theme.py index 7f609b948..14515f6ac 100644 --- a/theme.py +++ b/theme.py @@ -14,7 +14,7 @@ from shutil import copyfile from content import dangerousCSS -def getThemeFiles() -> []: +def _getThemeFiles() -> []: return ('epicyon.css', 'login.css', 'follow.css', 'suspended.css', 'calendar.css', 'blog.css', 'options.css', 'search.css', 'links.css') @@ -38,7 +38,7 @@ def getThemesList(baseDir: str) -> []: return themes -def setThemeInConfig(baseDir: str, name: str) -> bool: +def _setThemeInConfig(baseDir: str, name: str) -> bool: configFilename = baseDir + '/config.json' if not os.path.isfile(configFilename): return False @@ -49,7 +49,7 @@ def setThemeInConfig(baseDir: str, name: str) -> bool: return saveJson(configJson, configFilename) -def setNewswirePublishAsIcon(baseDir: str, useIcon: bool) -> bool: +def _setNewswirePublishAsIcon(baseDir: str, useIcon: bool) -> bool: """Shows the newswire publish action as an icon or a button """ configFilename = baseDir + '/config.json' @@ -62,7 +62,7 @@ def setNewswirePublishAsIcon(baseDir: str, useIcon: bool) -> bool: return saveJson(configJson, configFilename) -def setIconsAsButtons(baseDir: str, useButtons: bool) -> bool: +def _setIconsAsButtons(baseDir: str, useButtons: bool) -> bool: """Whether to show icons in the header (inbox, outbox, etc) as buttons """ @@ -76,7 +76,7 @@ def setIconsAsButtons(baseDir: str, useButtons: bool) -> bool: return saveJson(configJson, configFilename) -def setRssIconAtTop(baseDir: str, atTop: bool) -> bool: +def _setRssIconAtTop(baseDir: str, atTop: bool) -> bool: """Whether to show RSS icon at the top of the timeline """ configFilename = baseDir + '/config.json' @@ -89,7 +89,7 @@ def setRssIconAtTop(baseDir: str, atTop: bool) -> bool: return saveJson(configJson, configFilename) -def setPublishButtonAtTop(baseDir: str, atTop: bool) -> bool: +def _setPublishButtonAtTop(baseDir: str, atTop: bool) -> bool: """Whether to show the publish button above the title image in the newswire column """ @@ -103,7 +103,7 @@ def setPublishButtonAtTop(baseDir: str, atTop: bool) -> bool: return saveJson(configJson, configFilename) -def setFullWidthTimelineButtonHeader(baseDir: str, fullWidth: bool) -> bool: +def _setFullWidthTimelineButtonHeader(baseDir: str, fullWidth: bool) -> bool: """Shows the timeline button header containing inbox, outbox, calendar, etc as full width """ @@ -127,8 +127,8 @@ def getTheme(baseDir: str) -> str: return 'default' -def removeTheme(baseDir: str): - themeFiles = getThemeFiles() +def _removeTheme(baseDir: str): + themeFiles = _getThemeFiles() for filename in themeFiles: if os.path.isfile(baseDir + '/' + filename): os.remove(baseDir + '/' + filename) @@ -183,14 +183,14 @@ def setCSSparam(css: str, param: str, value: str) -> str: return newcss.strip() -def setThemeFromDict(baseDir: str, name: str, - themeParams: {}, bgParams: {}, - allowLocalNetworkAccess: bool) -> None: +def _setThemeFromDict(baseDir: str, name: str, + themeParams: {}, bgParams: {}, + allowLocalNetworkAccess: bool) -> None: """Uses a dictionary to set a theme """ if name: - setThemeInConfig(baseDir, name) - themeFiles = getThemeFiles() + _setThemeInConfig(baseDir, name) + themeFiles = _getThemeFiles() for filename in themeFiles: # check for custom css within the theme directory templateFilename = baseDir + '/theme/' + name + '/epicyon-' + filename @@ -215,33 +215,33 @@ def setThemeFromDict(baseDir: str, name: str, for paramName, paramValue in themeParams.items(): if paramName == 'newswire-publish-icon': if paramValue.lower() == 'true': - setNewswirePublishAsIcon(baseDir, True) + _setNewswirePublishAsIcon(baseDir, True) else: - setNewswirePublishAsIcon(baseDir, False) + _setNewswirePublishAsIcon(baseDir, False) continue elif paramName == 'full-width-timeline-buttons': if paramValue.lower() == 'true': - setFullWidthTimelineButtonHeader(baseDir, True) + _setFullWidthTimelineButtonHeader(baseDir, True) else: - setFullWidthTimelineButtonHeader(baseDir, False) + _setFullWidthTimelineButtonHeader(baseDir, False) continue elif paramName == 'icons-as-buttons': if paramValue.lower() == 'true': - setIconsAsButtons(baseDir, True) + _setIconsAsButtons(baseDir, True) else: - setIconsAsButtons(baseDir, False) + _setIconsAsButtons(baseDir, False) continue elif paramName == 'rss-icon-at-top': if paramValue.lower() == 'true': - setRssIconAtTop(baseDir, True) + _setRssIconAtTop(baseDir, True) else: - setRssIconAtTop(baseDir, False) + _setRssIconAtTop(baseDir, False) continue elif paramName == 'publish-button-at-top': if paramValue.lower() == 'true': - setPublishButtonAtTop(baseDir, True) + _setPublishButtonAtTop(baseDir, True) else: - setPublishButtonAtTop(baseDir, False) + _setPublishButtonAtTop(baseDir, False) continue css = setCSSparam(css, paramName, paramValue) filename = baseDir + '/' + filename @@ -249,17 +249,17 @@ def setThemeFromDict(baseDir: str, name: str, cssfile.write(css) if bgParams.get('login'): - setBackgroundFormat(baseDir, name, 'login', bgParams['login']) + _setBackgroundFormat(baseDir, name, 'login', bgParams['login']) if bgParams.get('follow'): - setBackgroundFormat(baseDir, name, 'follow', bgParams['follow']) + _setBackgroundFormat(baseDir, name, 'follow', bgParams['follow']) if bgParams.get('options'): - setBackgroundFormat(baseDir, name, 'options', bgParams['options']) + _setBackgroundFormat(baseDir, name, 'options', bgParams['options']) if bgParams.get('search'): - setBackgroundFormat(baseDir, name, 'search', bgParams['search']) + _setBackgroundFormat(baseDir, name, 'search', bgParams['search']) -def setBackgroundFormat(baseDir: str, name: str, - backgroundType: str, extension: str) -> None: +def _setBackgroundFormat(baseDir: str, name: str, + backgroundType: str, extension: str) -> None: """Sets the background file extension """ if extension == 'jpg': @@ -277,7 +277,7 @@ def setBackgroundFormat(baseDir: str, name: str, def enableGrayscale(baseDir: str) -> None: """Enables grayscale for the current theme """ - themeFiles = getThemeFiles() + themeFiles = _getThemeFiles() for filename in themeFiles: templateFilename = baseDir + '/' + filename if not os.path.isfile(templateFilename): @@ -300,7 +300,7 @@ def enableGrayscale(baseDir: str) -> None: def disableGrayscale(baseDir: str) -> None: """Disables grayscale for the current theme """ - themeFiles = getThemeFiles() + themeFiles = _getThemeFiles() for filename in themeFiles: templateFilename = baseDir + '/' + filename if not os.path.isfile(templateFilename): @@ -318,7 +318,7 @@ def disableGrayscale(baseDir: str) -> None: os.remove(grayscaleFilename) -def setCustomFont(baseDir: str): +def _setCustomFont(baseDir: str): """Uses a dictionary to set a theme """ customFontExt = None @@ -337,7 +337,7 @@ def setCustomFont(baseDir: str): if not customFontExt: return - themeFiles = getThemeFiles() + themeFiles = _getThemeFiles() for filename in themeFiles: templateFilename = baseDir + '/' + filename if not os.path.isfile(templateFilename): @@ -356,9 +356,9 @@ def setCustomFont(baseDir: str): cssfile.write(css) -def readVariablesFile(baseDir: str, themeName: str, - variablesFile: str, - allowLocalNetworkAccess: bool) -> None: +def _readVariablesFile(baseDir: str, themeName: str, + variablesFile: str, + allowLocalNetworkAccess: bool) -> None: """Reads variables from a file in the theme directory """ themeParams = loadJson(variablesFile, 0) @@ -370,14 +370,14 @@ def readVariablesFile(baseDir: str, themeName: str, "options": "jpg", "search": "jpg" } - setThemeFromDict(baseDir, themeName, themeParams, bgParams, - allowLocalNetworkAccess) + _setThemeFromDict(baseDir, themeName, themeParams, bgParams, + allowLocalNetworkAccess) -def setThemeDefault(baseDir: str, allowLocalNetworkAccess: bool): +def _setThemeDefault(baseDir: str, allowLocalNetworkAccess: bool): name = 'default' - removeTheme(baseDir) - setThemeInConfig(baseDir, name) + _removeTheme(baseDir) + _setThemeInConfig(baseDir, name) bgParams = { "login": "jpg", "follow": "jpg", @@ -394,11 +394,11 @@ def setThemeDefault(baseDir: str, allowLocalNetworkAccess: bool): "banner-height-mobile": "10vh", "search-banner-height-mobile": "15vh" } - setThemeFromDict(baseDir, name, themeParams, bgParams, - allowLocalNetworkAccess) + _setThemeFromDict(baseDir, name, themeParams, bgParams, + allowLocalNetworkAccess) -def setThemeFonts(baseDir: str, themeName: str) -> None: +def _setThemeFonts(baseDir: str, themeName: str) -> None: """Adds custom theme fonts """ themeNameLower = themeName.lower() @@ -422,7 +422,7 @@ def setThemeFonts(baseDir: str, themeName: str) -> None: break -def setThemeImages(baseDir: str, name: str) -> None: +def _setThemeImages(baseDir: str, name: str) -> None: """Changes the profile background image and banner to the defaults """ @@ -557,7 +557,7 @@ def setTheme(baseDir: str, name: str, domain: str, result = False prevThemeName = getTheme(baseDir) - removeTheme(baseDir) + _removeTheme(baseDir) themes = getThemesList(baseDir) for themeName in themes: @@ -573,21 +573,21 @@ def setTheme(baseDir: str, name: str, domain: str, if prevThemeName.lower() != themeNameLower: # change the banner and profile image # to the default for the theme - setThemeImages(baseDir, name) - setThemeFonts(baseDir, name) + _setThemeImages(baseDir, name) + _setThemeFonts(baseDir, name) result = True if not result: # default - setThemeDefault(baseDir) + _setThemeDefault(baseDir) result = True variablesFile = baseDir + '/theme/' + name + '/theme.json' if os.path.isfile(variablesFile): - readVariablesFile(baseDir, name, variablesFile, - allowLocalNetworkAccess) + _readVariablesFile(baseDir, name, variablesFile, + allowLocalNetworkAccess) - setCustomFont(baseDir) + _setCustomFont(baseDir) # set the news avatar newsAvatarThemeFilename = \ @@ -604,5 +604,5 @@ def setTheme(baseDir: str, name: str, domain: str, else: disableGrayscale(baseDir) - setThemeInConfig(baseDir, name) + _setThemeInConfig(baseDir, name) return result diff --git a/utils.py b/utils.py index 2ed990cc1..2468e5a51 100644 --- a/utils.py +++ b/utils.py @@ -197,7 +197,7 @@ def isSystemAccount(nickname: str) -> bool: return False -def createConfig(baseDir: str) -> None: +def _createConfig(baseDir: str) -> None: """Creates a configuration file """ configFilename = baseDir + '/config.json' @@ -211,7 +211,7 @@ def createConfig(baseDir: str) -> None: def setConfigParam(baseDir: str, variableName: str, variableValue) -> None: """Sets a configuration value """ - createConfig(baseDir) + _createConfig(baseDir) configFilename = baseDir + '/config.json' configJson = {} if os.path.isfile(configFilename): @@ -223,7 +223,7 @@ def setConfigParam(baseDir: str, variableName: str, variableValue) -> None: def getConfigParam(baseDir: str, variableName: str): """Gets a configuration value """ - createConfig(baseDir) + _createConfig(baseDir) configFilename = baseDir + '/config.json' configJson = loadJson(configFilename) if configJson: @@ -610,8 +610,8 @@ def getDomainFromActor(actor: str) -> (str, int): return domain, port -def setDefaultPetName(baseDir: str, nickname: str, domain: str, - followNickname: str, followDomain: str) -> None: +def _setDefaultPetName(baseDir: str, nickname: str, domain: str, + followNickname: str, followDomain: str) -> None: """Sets a default petname This helps especially when using onion or i2p address """ @@ -723,8 +723,8 @@ def followPerson(baseDir: str, nickname: str, domain: str, addPersonToCalendar(baseDir, nickname, domain, followNickname, followDomain) # add a default petname - setDefaultPetName(baseDir, nickname, domain, - followNickname, followDomain) + _setDefaultPetName(baseDir, nickname, domain, + followNickname, followDomain) return True @@ -864,7 +864,8 @@ def locatePost(baseDir: str, nickname: str, domain: str, return None -def removeAttachment(baseDir: str, httpPrefix: str, domain: str, postJson: {}): +def _removeAttachment(baseDir: str, httpPrefix: str, domain: str, + postJson: {}): if not postJson.get('attachment'): return if not postJson['attachment'][0].get('url'): @@ -907,8 +908,8 @@ def removeModerationPostFromIndex(baseDir: str, postUrl: str, ' from moderation index') -def isReplyToBlogPost(baseDir: str, nickname: str, domain: str, - postJsonObject: str): +def _isReplyToBlogPost(baseDir: str, nickname: str, domain: str, + postJsonObject: str): """Is the given post a reply to a blog post? """ if not postJsonObject.get('object'): @@ -947,8 +948,8 @@ def deletePost(baseDir: str, httpPrefix: str, return # don't remove replies to blog posts - if isReplyToBlogPost(baseDir, nickname, domain, - postJsonObject): + if _isReplyToBlogPost(baseDir, nickname, domain, + postJsonObject): return # remove from recent posts cache in memory @@ -966,7 +967,7 @@ def deletePost(baseDir: str, httpPrefix: str, del recentPostsCache['html'][postId] # remove any attachment - removeAttachment(baseDir, httpPrefix, domain, postJsonObject) + _removeAttachment(baseDir, httpPrefix, domain, postJsonObject) extensions = ('votes', 'arrived', 'muted') for ext in extensions: diff --git a/webapp_calendar.py b/webapp_calendar.py index 7b5b25bd3..e3a2dc495 100644 --- a/webapp_calendar.py +++ b/webapp_calendar.py @@ -89,11 +89,11 @@ def htmlCalendarDeleteConfirm(cssCache: {}, translate: {}, baseDir: str, return deletePostStr -def htmlCalendarDay(cssCache: {}, translate: {}, - baseDir: str, path: str, - year: int, monthNumber: int, dayNumber: int, - nickname: str, domain: str, dayEvents: [], - monthName: str, actor: str) -> str: +def _htmlCalendarDay(cssCache: {}, translate: {}, + baseDir: str, path: str, + year: int, monthNumber: int, dayNumber: int, + nickname: str, domain: str, dayEvents: [], + monthName: str, actor: str) -> str: """Show a day within the calendar """ accountDir = baseDir + '/accounts/' + nickname + '@' + domain @@ -251,10 +251,10 @@ def htmlCalendar(cssCache: {}, translate: {}, if events: if events.get(str(dayNumber)): dayEvents = events[str(dayNumber)] - return htmlCalendarDay(cssCache, translate, baseDir, path, - year, monthNumber, dayNumber, - nickname, domain, dayEvents, - monthName, actor) + return _htmlCalendarDay(cssCache, translate, baseDir, path, + year, monthNumber, dayNumber, + nickname, domain, dayEvents, + monthName, actor) events = \ getCalendarEvents(baseDir, nickname, domain, year, monthNumber) diff --git a/webapp_column_left.py b/webapp_column_left.py index cabd858af..6d444d839 100644 --- a/webapp_column_left.py +++ b/webapp_column_left.py @@ -19,18 +19,18 @@ from webapp_utils import htmlFooter from webapp_utils import getBannerFile -def linksExist(baseDir: str) -> bool: +def _linksExist(baseDir: str) -> bool: """Returns true if links have been created """ linksFilename = baseDir + '/accounts/links.txt' return os.path.isfile(linksFilename) -def getLeftColumnShares(baseDir: str, - httpPrefix: str, domainFull: str, - nickname: str, - maxSharesInLeftColumn: int, - translate: {}) -> []: +def _getLeftColumnShares(baseDir: str, + httpPrefix: str, domainFull: str, + nickname: str, + maxSharesInLeftColumn: int, + translate: {}) -> []: """get any shares and turn them into the left column links format """ pageNumber = 1 @@ -164,9 +164,9 @@ def getLeftColumnContent(baseDir: str, nickname: str, domainFull: str, # show a number of shares maxSharesInLeftColumn = 3 sharesList = \ - getLeftColumnShares(baseDir, - httpPrefix, domainFull, nickname, - maxSharesInLeftColumn, translate) + _getLeftColumnShares(baseDir, + httpPrefix, domainFull, nickname, + maxSharesInLeftColumn, translate) if linksList and sharesList: linksList = sharesList + linksList @@ -271,7 +271,7 @@ def htmlLinksMobile(cssCache: {}, baseDir: str, headerButtonsFrontScreen(translate, nickname, 'links', authorized, iconsAsButtons) + '
' - if linksExist(baseDir): + if _linksExist(baseDir): htmlStr += \ getLeftColumnContent(baseDir, nickname, domainFull, httpPrefix, translate, diff --git a/webapp_column_right.py b/webapp_column_right.py index d01928248..9e915382c 100644 --- a/webapp_column_right.py +++ b/webapp_column_right.py @@ -24,7 +24,7 @@ from webapp_utils import htmlPostSeparator from webapp_utils import headerButtonsFrontScreen -def votesIndicator(totalVotes: int, positiveVoting: bool) -> str: +def _votesIndicator(totalVotes: int, positiveVoting: bool) -> str: """Returns an indicator of the number of votes on a newswire item """ if totalVotes <= 0: @@ -177,8 +177,8 @@ def getRightColumnContent(baseDir: str, nickname: str, domainFull: str, # show the newswire lines newswireContentStr = \ - htmlNewswire(baseDir, newswire, nickname, moderator, translate, - positiveVoting) + _htmlNewswire(baseDir, newswire, nickname, moderator, translate, + positiveVoting) htmlStr += newswireContentStr # show the rss icon at the bottom, typically on the right hand side @@ -187,8 +187,8 @@ def getRightColumnContent(baseDir: str, nickname: str, domainFull: str, return htmlStr -def htmlNewswire(baseDir: str, newswire: {}, nickname: str, moderator: bool, - translate: {}, positiveVoting: bool) -> str: +def _htmlNewswire(baseDir: str, newswire: {}, nickname: str, moderator: bool, + translate: {}, positiveVoting: bool) -> str: """Converts a newswire dict into html """ separatorStr = htmlPostSeparator(baseDir, 'right') @@ -220,7 +220,7 @@ def htmlNewswire(baseDir: str, newswire: {}, nickname: str, moderator: bool, if moderator: totalVotes = votesOnNewswireItem(item[2]) totalVotesStr = \ - votesIndicator(totalVotes, positiveVoting) + _votesIndicator(totalVotes, positiveVoting) title = removeLongWords(item[0], 16, []).replace('\n', '
') htmlStr += '

' + \ @@ -247,7 +247,7 @@ def htmlNewswire(baseDir: str, newswire: {}, nickname: str, moderator: bool, # show a number of ticks or crosses for how many # votes for or against totalVotesStr = \ - votesIndicator(totalVotes, positiveVoting) + _votesIndicator(totalVotes, positiveVoting) title = removeLongWords(item[0], 16, []).replace('\n', '
') if moderator and moderatedItem: diff --git a/webapp_create_post.py b/webapp_create_post.py index 7768f490f..d1c9f2e89 100644 --- a/webapp_create_post.py +++ b/webapp_create_post.py @@ -17,8 +17,8 @@ from webapp_utils import htmlHeaderWithExternalStyle from webapp_utils import htmlFooter -def htmlFollowingDataList(baseDir: str, nickname: str, - domain: str, domainFull: str) -> str: +def _htmlFollowingDataList(baseDir: str, nickname: str, + domain: str, domainFull: str) -> str: """Returns a datalist of handles being followed """ listStr = '\n' @@ -57,20 +57,20 @@ def htmlFollowingDataList(baseDir: str, nickname: str, return listStr -def htmlNewPostDropDown(scopeIcon: str, scopeDescription: str, - replyStr: str, - translate: {}, - showPublicOnDropdown: bool, - defaultTimeline: str, - pathBase: str, - dropdownNewPostSuffix: str, - dropdownNewBlogSuffix: str, - dropdownUnlistedSuffix: str, - dropdownFollowersSuffix: str, - dropdownDMSuffix: str, - dropdownReminderSuffix: str, - dropdownEventSuffix: str, - dropdownReportSuffix: str) -> str: +def _htmlNewPostDropDown(scopeIcon: str, scopeDescription: str, + replyStr: str, + translate: {}, + showPublicOnDropdown: bool, + defaultTimeline: str, + pathBase: str, + dropdownNewPostSuffix: str, + dropdownNewBlogSuffix: str, + dropdownUnlistedSuffix: str, + dropdownFollowersSuffix: str, + dropdownDMSuffix: str, + dropdownReminderSuffix: str, + dropdownEventSuffix: str, + dropdownReportSuffix: str) -> str: """Returns the html for a drop down list of new post types """ dropDownContent = '

\n' @@ -617,20 +617,20 @@ def htmlNewPost(cssCache: {}, mediaInstance: bool, translate: {}, dropDownContent = '' if not reportUrl and not shareDescription: dropDownContent = \ - htmlNewPostDropDown(scopeIcon, scopeDescription, - replyStr, - translate, - showPublicOnDropdown, - defaultTimeline, - pathBase, - dropdownNewPostSuffix, - dropdownNewBlogSuffix, - dropdownUnlistedSuffix, - dropdownFollowersSuffix, - dropdownDMSuffix, - dropdownReminderSuffix, - dropdownEventSuffix, - dropdownReportSuffix) + _htmlNewPostDropDown(scopeIcon, scopeDescription, + replyStr, + translate, + showPublicOnDropdown, + defaultTimeline, + pathBase, + dropdownNewPostSuffix, + dropdownNewBlogSuffix, + dropdownUnlistedSuffix, + dropdownFollowersSuffix, + dropdownDMSuffix, + dropdownReminderSuffix, + dropdownEventSuffix, + dropdownReportSuffix) else: if not shareDescription: # reporting a post to moderator @@ -717,7 +717,7 @@ def htmlNewPost(cssCache: {}, mediaInstance: bool, translate: {}, ' \n' newPostForm += \ - htmlFollowingDataList(baseDir, nickname, domain, domainFull) + _htmlFollowingDataList(baseDir, nickname, domain, domainFull) newPostForm += '' selectedStr = '' diff --git a/webapp_frontscreen.py b/webapp_frontscreen.py index 621b1cb23..1e289f4a8 100644 --- a/webapp_frontscreen.py +++ b/webapp_frontscreen.py @@ -20,14 +20,14 @@ from webapp_column_right import getRightColumnContent from webapp_post import individualPostAsHtml -def htmlFrontScreenPosts(recentPostsCache: {}, maxRecentPosts: int, - translate: {}, - baseDir: str, httpPrefix: str, - nickname: str, domain: str, port: int, - session, wfRequest: {}, personCache: {}, - projectVersion: str, - YTReplacementDomain: str, - showPublishedDateOnly: bool) -> str: +def _htmlFrontScreenPosts(recentPostsCache: {}, maxRecentPosts: int, + translate: {}, + baseDir: str, httpPrefix: str, + nickname: str, domain: str, port: int, + session, wfRequest: {}, personCache: {}, + projectVersion: str, + YTReplacementDomain: str, + showPublishedDateOnly: bool) -> str: """Shows posts on the front screen of a news instance These should only be public blog posts from the features timeline which is the blog timeline of the news actor @@ -139,14 +139,14 @@ def htmlFrontScreen(rssIconAtTop: bool, bannerFile, bannerFilename = \ getBannerFile(baseDir, nickname, domain, theme) profileStr += \ - htmlFrontScreenPosts(recentPostsCache, maxRecentPosts, - translate, - baseDir, httpPrefix, - nickname, domain, port, - session, wfRequest, personCache, - projectVersion, - YTReplacementDomain, - showPublishedDateOnly) + licenseStr + _htmlFrontScreenPosts(recentPostsCache, maxRecentPosts, + translate, + baseDir, httpPrefix, + nickname, domain, port, + session, wfRequest, personCache, + projectVersion, + YTReplacementDomain, + showPublishedDateOnly) + licenseStr # Footer which is only used for system accounts profileFooterStr = ' \n' diff --git a/webapp_hashtagswarm.py b/webapp_hashtagswarm.py index 61dd46b00..47369045f 100644 --- a/webapp_hashtagswarm.py +++ b/webapp_hashtagswarm.py @@ -51,7 +51,7 @@ def getHashtagCategoriesFeed(baseDir: str, return rssStr -def getHashtagDomainMax(domainHistogram: {}) -> str: +def _getHashtagDomainMax(domainHistogram: {}) -> str: """Returns the domain with the maximum number of hashtags """ maxCount = 1 @@ -63,7 +63,7 @@ def getHashtagDomainMax(domainHistogram: {}) -> str: return maxDomain -def getHashtagDomainHistogram(domainHistogram: {}, translate: {}) -> str: +def _getHashtagDomainHistogram(domainHistogram: {}, translate: {}) -> str: """Returns the html for a histogram of domains from which hashtags are coming """ @@ -88,7 +88,7 @@ def getHashtagDomainHistogram(domainHistogram: {}, translate: {}) -> str: rightColStr = '' for i in range(len(domainHistogram)): - domain = getHashtagDomainMax(domainHistogram) + domain = _getHashtagDomainMax(domainHistogram) if not domain: break percent = int(domainHistogram[domain] * 100 / totalCount) @@ -224,7 +224,7 @@ def htmlHashTagSwarm(baseDir: str, actor: str, translate: {}) -> str: getContentWarningButton('alltags', translate, tagSwarmStr) tagSwarmHtml = categorySwarmStr + tagSwarmStr.strip() + '\n' - # tagSwarmHtml += getHashtagDomainHistogram(domainHistogram, translate) + # tagSwarmHtml += _getHashtagDomainHistogram(domainHistogram, translate) return tagSwarmHtml diff --git a/webapp_media.py b/webapp_media.py index bb32d8fd7..ba5fa9971 100644 --- a/webapp_media.py +++ b/webapp_media.py @@ -7,8 +7,8 @@ __email__ = "bob@freedombone.net" __status__ = "Production" -def addEmbeddedVideoFromSites(translate: {}, content: str, - width=400, height=300) -> str: +def _addEmbeddedVideoFromSites(translate: {}, content: str, + width=400, height=300) -> str: """Adds embedded videos """ if '>vimeo.com/' in content: @@ -122,7 +122,7 @@ def addEmbeddedVideoFromSites(translate: {}, content: str, return content -def addEmbeddedAudio(translate: {}, content: str) -> str: +def _addEmbeddedAudio(translate: {}, content: str) -> str: """Adds embedded audio for mp3/ogg """ if not ('.mp3' in content or '.ogg' in content): @@ -167,8 +167,8 @@ def addEmbeddedAudio(translate: {}, content: str) -> str: return content -def addEmbeddedVideo(translate: {}, content: str, - width=400, height=300) -> str: +def _addEmbeddedVideo(translate: {}, content: str, + width=400, height=300) -> str: """Adds embedded video for mp4/webm/ogv """ if not ('.mp4' in content or '.webm' in content or '.ogv' in content): @@ -219,6 +219,6 @@ def addEmbeddedVideo(translate: {}, content: str, def addEmbeddedElements(translate: {}, content: str) -> str: """Adds embedded elements for various media types """ - content = addEmbeddedVideoFromSites(translate, content) - content = addEmbeddedAudio(translate, content) - return addEmbeddedVideo(translate, content) + content = _addEmbeddedVideoFromSites(translate, content) + content = _addEmbeddedAudio(translate, content) + return _addEmbeddedVideo(translate, content) diff --git a/webapp_post.py b/webapp_post.py index 69a9eed4c..412d7b78d 100644 --- a/webapp_post.py +++ b/webapp_post.py @@ -63,7 +63,7 @@ from webapp_question import insertQuestion from devices import E2EEdecryptMessageFromDevice -def logPostTiming(enableTimingLog: bool, postStartTime, debugId: str) -> None: +def _logPostTiming(enableTimingLog: bool, postStartTime, debugId: str) -> None: """Create a log of timings for performance tuning """ if not enableTimingLog: @@ -92,10 +92,10 @@ def preparePostFromHtmlCache(postHtml: str, boxName: str, return withPageNumber -def saveIndividualPostAsHtmlToCache(baseDir: str, - nickname: str, domain: str, - postJsonObject: {}, - postHtml: str) -> bool: +def _saveIndividualPostAsHtmlToCache(baseDir: str, + nickname: str, domain: str, + postJsonObject: {}, + postHtml: str) -> bool: """Saves the given html for a post to a cache file This is so that it can be quickly reloaded on subsequent refresh of the timeline @@ -118,23 +118,23 @@ def saveIndividualPostAsHtmlToCache(baseDir: str, return False -def getPostFromRecentCache(session, - baseDir: str, - httpPrefix: str, - nickname: str, domain: str, - postJsonObject: {}, - postActor: str, - personCache: {}, - allowDownloads: bool, - showPublicOnly: bool, - storeToCache: bool, - boxName: str, - avatarUrl: str, - enableTimingLog: bool, - postStartTime, - pageNumber: int, - recentPostsCache: {}, - maxRecentPosts: int) -> str: +def _getPostFromRecentCache(session, + baseDir: str, + httpPrefix: str, + nickname: str, domain: str, + postJsonObject: {}, + postActor: str, + personCache: {}, + allowDownloads: bool, + showPublicOnly: bool, + storeToCache: bool, + boxName: str, + avatarUrl: str, + enableTimingLog: bool, + postStartTime, + pageNumber: int, + recentPostsCache: {}, + maxRecentPosts: int) -> str: """Attempts to get the html post from the recent posts cache in memory """ if boxName == 'tlmedia': @@ -157,13 +157,13 @@ def getPostFromRecentCache(session, getPersonAvatarUrl(baseDir, postActor, personCache, allowDownloads) - logPostTiming(enableTimingLog, postStartTime, '2.1') + _logPostTiming(enableTimingLog, postStartTime, '2.1') updateAvatarImageCache(session, baseDir, httpPrefix, postActor, avatarUrl, personCache, allowDownloads) - logPostTiming(enableTimingLog, postStartTime, '2.2') + _logPostTiming(enableTimingLog, postStartTime, '2.2') postHtml = \ loadIndividualPostAsHtmlFromCache(baseDir, nickname, domain, @@ -174,15 +174,15 @@ def getPostFromRecentCache(session, postHtml = preparePostFromHtmlCache(postHtml, boxName, pageNumber) updateRecentPostsCache(recentPostsCache, maxRecentPosts, postJsonObject, postHtml) - logPostTiming(enableTimingLog, postStartTime, '3') + _logPostTiming(enableTimingLog, postStartTime, '3') return postHtml -def getAvatarImageHtml(showAvatarOptions: bool, - nickname: str, domainFull: str, - avatarUrl: str, postActor: str, - translate: {}, avatarPosition: str, - pageNumber: int, messageIdStr: str) -> str: +def _getAvatarImageHtml(showAvatarOptions: bool, + nickname: str, domainFull: str, + avatarUrl: str, postActor: str, + translate: {}, avatarPosition: str, + pageNumber: int, messageIdStr: str) -> str: """Get html for the avatar image """ avatarLink = '' @@ -215,10 +215,10 @@ def getAvatarImageHtml(showAvatarOptions: bool, return avatarLink.strip() -def getReplyIconHtml(nickname: str, isPublicRepeat: bool, - showIcons: bool, commentsEnabled: bool, - postJsonObject: {}, pageNumberParam: str, - translate: {}) -> str: +def _getReplyIconHtml(nickname: str, isPublicRepeat: bool, + showIcons: bool, commentsEnabled: bool, + postJsonObject: {}, pageNumberParam: str, + translate: {}) -> str: """Returns html for the reply icon/button """ replyStr = '' @@ -274,9 +274,9 @@ def getReplyIconHtml(nickname: str, isPublicRepeat: bool, return replyStr -def getEditIconHtml(baseDir: str, nickname: str, domainFull: str, - postJsonObject: {}, actorNickname: str, - translate: {}, isEvent: bool) -> str: +def _getEditIconHtml(baseDir: str, nickname: str, domainFull: str, + postJsonObject: {}, actorNickname: str, + translate: {}, isEvent: bool) -> str: """Returns html for the edit icon/button """ editStr = '' @@ -330,15 +330,15 @@ def getEditIconHtml(baseDir: str, nickname: str, domainFull: str, return editStr -def getAnnounceIconHtml(nickname: str, domainFull: str, - postJsonObject: {}, - isPublicRepeat: bool, - isModerationPost: bool, - showRepeatIcon: bool, - translate: {}, - pageNumberParam: str, - timelinePostBookmark: str, - boxName: str) -> str: +def _getAnnounceIconHtml(nickname: str, domainFull: str, + postJsonObject: {}, + isPublicRepeat: bool, + isModerationPost: bool, + showRepeatIcon: bool, + translate: {}, + pageNumberParam: str, + timelinePostBookmark: str, + boxName: str) -> str: """Returns html for announce icon/button """ announceStr = '' @@ -372,15 +372,15 @@ def getAnnounceIconHtml(nickname: str, domainFull: str, return announceStr -def getLikeIconHtml(nickname: str, domainFull: str, - isModerationPost: bool, - showLikeButton: bool, - postJsonObject: {}, - enableTimingLog: bool, - postStartTime, - translate: {}, pageNumberParam: str, - timelinePostBookmark: str, - boxName: str) -> str: +def _getLikeIconHtml(nickname: str, domainFull: str, + isModerationPost: bool, + showLikeButton: bool, + postJsonObject: {}, + enableTimingLog: bool, + postStartTime, + translate: {}, pageNumberParam: str, + timelinePostBookmark: str, + boxName: str) -> str: """Returns html for like icon/button """ likeStr = '' @@ -390,7 +390,7 @@ def getLikeIconHtml(nickname: str, domainFull: str, likeTitle = translate['Like this post'] likeCount = noOfLikes(postJsonObject) - logPostTiming(enableTimingLog, postStartTime, '12.1') + _logPostTiming(enableTimingLog, postStartTime, '12.1') likeCountStr = '' if likeCount > 0: @@ -406,7 +406,7 @@ def getLikeIconHtml(nickname: str, domainFull: str, likeLink = 'unlike' likeTitle = translate['Undo the like'] - logPostTiming(enableTimingLog, postStartTime, '12.2') + _logPostTiming(enableTimingLog, postStartTime, '12.2') likeStr = '' if likeCountStr: @@ -430,14 +430,14 @@ def getLikeIconHtml(nickname: str, domainFull: str, return likeStr -def getBookmarkIconHtml(nickname: str, domainFull: str, - postJsonObject: {}, - isModerationPost: bool, - translate: {}, - enableTimingLog: bool, - postStartTime, boxName: str, - pageNumberParam: str, - timelinePostBookmark: str) -> str: +def _getBookmarkIconHtml(nickname: str, domainFull: str, + postJsonObject: {}, + isModerationPost: bool, + translate: {}, + enableTimingLog: bool, + postStartTime, boxName: str, + pageNumberParam: str, + timelinePostBookmark: str) -> str: """Returns html for bookmark icon/button """ bookmarkStr = '' @@ -452,7 +452,7 @@ def getBookmarkIconHtml(nickname: str, domainFull: str, bookmarkIcon = 'bookmark.png' bookmarkLink = 'unbookmark' bookmarkTitle = translate['Undo the bookmark'] - logPostTiming(enableTimingLog, postStartTime, '12.6') + _logPostTiming(enableTimingLog, postStartTime, '12.6') bookmarkStr = \ ' str: +def _getDeleteIconHtml(nickname: str, domainFull: str, + allowDeletion: bool, + postActor: str, + messageId: str, + postJsonObject: {}, + pageNumberParam: str, + translate: {}) -> str: """Returns html for delete icon/button """ deleteStr = '' @@ -541,8 +541,8 @@ def getDeleteIconHtml(nickname: str, domainFull: str, return deleteStr -def getPublishedDateStr(postJsonObject: {}, - showPublishedDateOnly: bool) -> str: +def _getPublishedDateStr(postJsonObject: {}, + showPublishedDateOnly: bool) -> str: """Return the html for the published date on a post """ publishedStr = '' @@ -575,9 +575,9 @@ def getPublishedDateStr(postJsonObject: {}, return publishedStr -def getBlogCitationsHtml(boxName: str, - postJsonObject: {}, - translate: {}) -> str: +def _getBlogCitationsHtml(boxName: str, + postJsonObject: {}, + translate: {}) -> str: """Returns blog citations as html """ # show blog citations @@ -609,7 +609,7 @@ def getBlogCitationsHtml(boxName: str, return citationsStr -def boostOwnTootHtml(translate: {}) -> str: +def _boostOwnTootHtml(translate: {}) -> str: """The html title for announcing your own post """ return ' \n' -def announceUnattributedHtml(translate: {}, - postJsonObject: {}) -> str: +def _announceUnattributedHtml(translate: {}, + postJsonObject: {}) -> str: """Returns the html for an announce title where there is no attribution on the announced post """ @@ -634,10 +634,10 @@ def announceUnattributedHtml(translate: {}, '" class="announceOrReply">@unattributed\n' -def announceWithoutDisplayNameHtml(translate: {}, - announceNickname: str, - announceDomain: str, - postJsonObject: {}) -> str: +def _announceWithoutDisplayNameHtml(translate: {}, + announceNickname: str, + announceDomain: str, + postJsonObject: {}) -> str: """Returns html for an announce title where there is no display name only a handle nick@domain """ @@ -650,9 +650,9 @@ def announceWithoutDisplayNameHtml(translate: {}, announceNickname + '@' + announceDomain + '\n' -def announceWithDisplayNameHtml(translate: {}, - postJsonObject: {}, - announceDisplayName: str) -> str: +def _announceWithDisplayNameHtml(translate: {}, + postJsonObject: {}, + announceDisplayName: str) -> str: """Returns html for an announce having a display name """ return ' ' + announceDisplayName + '\n' -def getPostTitleAnnounceHtml(baseDir: str, - httpPrefix: str, - nickname: str, domain: str, - showRepeatIcon: bool, - isAnnounced: bool, - postJsonObject: {}, - postActor: str, - translate: {}, - enableTimingLog: bool, - postStartTime, - boxName: str, - personCache: {}, - allowDownloads: bool, - avatarPosition: str, - pageNumber: int, - messageIdStr: str, - containerClassIcons: str, - containerClass: str) -> (str, str, str, str): +def _getPostTitleAnnounceHtml(baseDir: str, + httpPrefix: str, + nickname: str, domain: str, + showRepeatIcon: bool, + isAnnounced: bool, + postJsonObject: {}, + postActor: str, + translate: {}, + enableTimingLog: bool, + postStartTime, + boxName: str, + personCache: {}, + allowDownloads: bool, + avatarPosition: str, + pageNumber: int, + messageIdStr: str, + containerClassIcons: str, + containerClass: str) -> (str, str, str, str): """Returns the announce title of a post containing names of participants x announces y """ @@ -695,10 +695,10 @@ def getPostTitleAnnounceHtml(baseDir: str, attributedTo = postJsonObject['object']['attributedTo'] if attributedTo.startswith(postActor): - titleStr += boostOwnTootHtml(translate) + titleStr += _boostOwnTootHtml(translate) else: # boosting another person's post - logPostTiming(enableTimingLog, postStartTime, '13.2') + _logPostTiming(enableTimingLog, postStartTime, '13.2') announceNickname = None if attributedTo: announceNickname = getNicknameFromActor(attributedTo) @@ -710,7 +710,7 @@ def getPostTitleAnnounceHtml(baseDir: str, announceDisplayName = \ getDisplayName(baseDir, attributedTo, personCache) if announceDisplayName: - logPostTiming(enableTimingLog, postStartTime, '13.3') + _logPostTiming(enableTimingLog, postStartTime, '13.3') # add any emoji to the display name if ':' in announceDisplayName: @@ -719,11 +719,11 @@ def getPostTitleAnnounceHtml(baseDir: str, nickname, domain, announceDisplayName, False) - logPostTiming(enableTimingLog, postStartTime, '13.3.1') + _logPostTiming(enableTimingLog, postStartTime, '13.3.1') titleStr += \ - announceWithDisplayNameHtml(translate, - postJsonObject, - announceDisplayName) + _announceWithDisplayNameHtml(translate, + postJsonObject, + announceDisplayName) # show avatar of person replied to announceActor = \ postJsonObject['object']['attributedTo'] @@ -731,7 +731,7 @@ def getPostTitleAnnounceHtml(baseDir: str, getPersonAvatarUrl(baseDir, announceActor, personCache, allowDownloads) - logPostTiming(enableTimingLog, postStartTime, '13.4') + _logPostTiming(enableTimingLog, postStartTime, '13.4') if announceAvatarUrl: idx = 'Show options for this person' @@ -756,23 +756,23 @@ def getPostTitleAnnounceHtml(baseDir: str, '/>\n
\n' else: titleStr += \ - announceWithoutDisplayNameHtml(translate, - announceNickname, - announceDomain, - postJsonObject) + _announceWithoutDisplayNameHtml(translate, + announceNickname, + announceDomain, + postJsonObject) else: titleStr += \ - announceUnattributedHtml(translate, - postJsonObject) + _announceUnattributedHtml(translate, + postJsonObject) else: titleStr += \ - announceUnattributedHtml(translate, postJsonObject) + _announceUnattributedHtml(translate, postJsonObject) return (titleStr, replyAvatarImageInPost, containerClassIcons, containerClass) -def replyToYourselfHtml(translate: {}, ) -> str: +def _replyToYourselfHtml(translate: {}, ) -> str: """Returns html for a title which is a reply to yourself """ return ' \n' -def replyToUnknownHtml(translate: {}, - postJsonObject: {}) -> str: +def _replyToUnknownHtml(translate: {}, + postJsonObject: {}) -> str: """Returns the html title for a reply to an unknown handle """ return ' @unknown\n' -def replyWithUnknownPathHtml(translate: {}, - postJsonObject: {}, - postDomain: str) -> str: +def _replyWithUnknownPathHtml(translate: {}, + postJsonObject: {}, + postDomain: str) -> str: """Returns html title for a reply with an unknown path eg. does not contain /statuses/ """ @@ -812,8 +812,8 @@ def replyWithUnknownPathHtml(translate: {}, postDomain + '\n' -def getReplyHtml(translate: {}, - inReplyTo: str, replyDisplayName: str) -> str: +def _getReplyHtml(translate: {}, + inReplyTo: str, replyDisplayName: str) -> str: """Returns html title for a reply """ return ' ' + \ @@ -827,9 +827,9 @@ def getReplyHtml(translate: {}, replyDisplayName + '\n' -def getReplyWithoutDisplayName(translate: {}, - inReplyTo: str, - replyNickname: str, replyDomain: str) -> str: +def _getReplyWithoutDisplayName(translate: {}, + inReplyTo: str, + replyNickname: str, replyDomain: str) -> str: """Returns html for a reply without a display name, only a handle nick@domain """ @@ -842,24 +842,24 @@ def getReplyWithoutDisplayName(translate: {}, replyNickname + '@' + replyDomain + '\n' -def getPostTitleReplyHtml(baseDir: str, - httpPrefix: str, - nickname: str, domain: str, - showRepeatIcon: bool, - isAnnounced: bool, - postJsonObject: {}, - postActor: str, - translate: {}, - enableTimingLog: bool, - postStartTime, - boxName: str, - personCache: {}, - allowDownloads: bool, - avatarPosition: str, - pageNumber: int, - messageIdStr: str, - containerClassIcons: str, - containerClass: str) -> (str, str, str, str): +def _getPostTitleReplyHtml(baseDir: str, + httpPrefix: str, + nickname: str, domain: str, + showRepeatIcon: bool, + isAnnounced: bool, + postJsonObject: {}, + postActor: str, + translate: {}, + enableTimingLog: bool, + postStartTime, + boxName: str, + personCache: {}, + allowDownloads: bool, + avatarPosition: str, + pageNumber: int, + messageIdStr: str, + containerClassIcons: str, + containerClass: str) -> (str, str, str, str): """Returns the reply title of a post containing names of participants x replies to y """ @@ -873,7 +873,7 @@ def getPostTitleReplyHtml(baseDir: str, containerClassIcons = 'containericons darker' containerClass = 'container darker' if postJsonObject['object']['inReplyTo'].startswith(postActor): - titleStr += replyToYourselfHtml(translate) + titleStr += _replyToYourselfHtml(translate) return (titleStr, replyAvatarImageInPost, containerClassIcons, containerClass) @@ -894,7 +894,7 @@ def getPostTitleReplyHtml(baseDir: str, if replyDisplayName: # add emoji to the display name if ':' in replyDisplayName: - logPostTiming(enableTimingLog, postStartTime, '13.5') + _logPostTiming(enableTimingLog, postStartTime, '13.5') replyDisplayName = \ addEmojiToDisplayName(baseDir, @@ -903,12 +903,12 @@ def getPostTitleReplyHtml(baseDir: str, domain, replyDisplayName, False) - logPostTiming(enableTimingLog, postStartTime, '13.6') + _logPostTiming(enableTimingLog, postStartTime, '13.6') titleStr += \ - getReplyHtml(translate, inReplyTo, replyDisplayName) + _getReplyHtml(translate, inReplyTo, replyDisplayName) - logPostTiming(enableTimingLog, postStartTime, '13.7') + _logPostTiming(enableTimingLog, postStartTime, '13.7') # show avatar of person replied to replyAvatarUrl = \ @@ -917,7 +917,7 @@ def getPostTitleReplyHtml(baseDir: str, personCache, allowDownloads) - logPostTiming(enableTimingLog, postStartTime, '13.8') + _logPostTiming(enableTimingLog, postStartTime, '13.8') if replyAvatarUrl: replyAvatarImageInPost = \ @@ -947,12 +947,13 @@ def getPostTitleReplyHtml(baseDir: str, inReplyTo = \ postJsonObject['object']['inReplyTo'] titleStr += \ - getReplyWithoutDisplayName(translate, - inReplyTo, - replyNickname, replyDomain) + _getReplyWithoutDisplayName(translate, + inReplyTo, + replyNickname, + replyDomain) else: titleStr += \ - replyToUnknownHtml(translate, postJsonObject) + _replyToUnknownHtml(translate, postJsonObject) else: postDomain = \ postJsonObject['object']['inReplyTo'] @@ -963,31 +964,31 @@ def getPostTitleReplyHtml(baseDir: str, postDomain = postDomain.split('/', 1)[0] if postDomain: titleStr += \ - replyWithUnknownPathHtml(translate, - postJsonObject, postDomain) + _replyWithUnknownPathHtml(translate, + postJsonObject, postDomain) return (titleStr, replyAvatarImageInPost, containerClassIcons, containerClass) -def getPostTitleHtml(baseDir: str, - httpPrefix: str, - nickname: str, domain: str, - showRepeatIcon: bool, - isAnnounced: bool, - postJsonObject: {}, - postActor: str, - translate: {}, - enableTimingLog: bool, - postStartTime, - boxName: str, - personCache: {}, - allowDownloads: bool, - avatarPosition: str, - pageNumber: int, - messageIdStr: str, - containerClassIcons: str, - containerClass: str) -> (str, str, str, str): +def _getPostTitleHtml(baseDir: str, + httpPrefix: str, + nickname: str, domain: str, + showRepeatIcon: bool, + isAnnounced: bool, + postJsonObject: {}, + postActor: str, + translate: {}, + enableTimingLog: bool, + postStartTime, + boxName: str, + personCache: {}, + allowDownloads: bool, + avatarPosition: str, + pageNumber: int, + messageIdStr: str, + containerClassIcons: str, + containerClass: str) -> (str, str, str, str): """Returns the title of a post containing names of participants x replies to y, x announces y, etc """ @@ -998,52 +999,52 @@ def getPostTitleHtml(baseDir: str, containerClassIcons, containerClass) if isAnnounced: - return getPostTitleAnnounceHtml(baseDir, - httpPrefix, - nickname, domain, - showRepeatIcon, - isAnnounced, - postJsonObject, - postActor, - translate, - enableTimingLog, - postStartTime, - boxName, - personCache, - allowDownloads, - avatarPosition, - pageNumber, - messageIdStr, - containerClassIcons, - containerClass) + return _getPostTitleAnnounceHtml(baseDir, + httpPrefix, + nickname, domain, + showRepeatIcon, + isAnnounced, + postJsonObject, + postActor, + translate, + enableTimingLog, + postStartTime, + boxName, + personCache, + allowDownloads, + avatarPosition, + pageNumber, + messageIdStr, + containerClassIcons, + containerClass) - return getPostTitleReplyHtml(baseDir, - httpPrefix, - nickname, domain, - showRepeatIcon, - isAnnounced, - postJsonObject, - postActor, - translate, - enableTimingLog, - postStartTime, - boxName, - personCache, - allowDownloads, - avatarPosition, - pageNumber, - messageIdStr, - containerClassIcons, - containerClass) + return _getPostTitleReplyHtml(baseDir, + httpPrefix, + nickname, domain, + showRepeatIcon, + isAnnounced, + postJsonObject, + postActor, + translate, + enableTimingLog, + postStartTime, + boxName, + personCache, + allowDownloads, + avatarPosition, + pageNumber, + messageIdStr, + containerClassIcons, + containerClass) -def getFooterWithIcons(showIcons: bool, - containerClassIcons: str, - replyStr: str, announceStr: str, - likeStr: str, bookmarkStr: str, - deleteStr: str, muteStr: str, editStr: str, - postJsonObject: {}, publishedLink: str, - timeClass: str, publishedStr: str) -> str: +def _getFooterWithIcons(showIcons: bool, + containerClassIcons: str, + replyStr: str, announceStr: str, + likeStr: str, bookmarkStr: str, + deleteStr: str, muteStr: str, editStr: str, + postJsonObject: {}, publishedLink: str, + timeClass: str, publishedStr: str) -> str: """Returns the html for a post footer containing icons """ if not showIcons: @@ -1098,14 +1099,14 @@ def individualPostAsHtml(allowDownloads: bool, # accurate timing of different parts of the code enableTimingLog = not allowDownloads - logPostTiming(enableTimingLog, postStartTime, '1') + _logPostTiming(enableTimingLog, postStartTime, '1') avatarPosition = '' messageId = '' if postJsonObject.get('id'): messageId = removeIdEnding(postJsonObject['id']) - logPostTiming(enableTimingLog, postStartTime, '2') + _logPostTiming(enableTimingLog, postStartTime, '2') messageIdStr = '' if messageId: @@ -1119,25 +1120,25 @@ def individualPostAsHtml(allowDownloads: bool, # get the html post from the recent posts cache if it exists there postHtml = \ - getPostFromRecentCache(session, baseDir, - httpPrefix, nickname, domain, - postJsonObject, - postActor, - personCache, - allowDownloads, - showPublicOnly, - storeToCache, - boxName, - avatarUrl, - enableTimingLog, - postStartTime, - pageNumber, - recentPostsCache, - maxRecentPosts) + _getPostFromRecentCache(session, baseDir, + httpPrefix, nickname, domain, + postJsonObject, + postActor, + personCache, + allowDownloads, + showPublicOnly, + storeToCache, + boxName, + avatarUrl, + enableTimingLog, + postStartTime, + pageNumber, + recentPostsCache, + maxRecentPosts) if postHtml: return postHtml - logPostTiming(enableTimingLog, postStartTime, '4') + _logPostTiming(enableTimingLog, postStartTime, '4') avatarUrl = \ getAvatarImageUrl(session, @@ -1145,7 +1146,7 @@ def individualPostAsHtml(allowDownloads: bool, postActor, personCache, avatarUrl, allowDownloads) - logPostTiming(enableTimingLog, postStartTime, '5') + _logPostTiming(enableTimingLog, postStartTime, '5') # get the display name if domainFull not in postActor: @@ -1156,7 +1157,7 @@ def individualPostAsHtml(allowDownloads: bool, projectVersion, httpPrefix, nickname, domain, 'outbox', 72367) - logPostTiming(enableTimingLog, postStartTime, '6') + _logPostTiming(enableTimingLog, postStartTime, '6') if avatarUrl2: avatarUrl = avatarUrl2 @@ -1168,14 +1169,14 @@ def individualPostAsHtml(allowDownloads: bool, nickname, domain, displayName, False) - logPostTiming(enableTimingLog, postStartTime, '7') + _logPostTiming(enableTimingLog, postStartTime, '7') avatarLink = \ - getAvatarImageHtml(showAvatarOptions, - nickname, domainFull, - avatarUrl, postActor, - translate, avatarPosition, - pageNumber, messageIdStr) + _getAvatarImageHtml(showAvatarOptions, + nickname, domainFull, + avatarUrl, postActor, + translate, avatarPosition, + pageNumber, messageIdStr) avatarImageInPost = \ '
' + avatarLink + '
\n' @@ -1215,7 +1216,7 @@ def individualPostAsHtml(allowDownloads: bool, postJsonObject = postJsonAnnounce isAnnounced = True - logPostTiming(enableTimingLog, postStartTime, '8') + _logPostTiming(enableTimingLog, postStartTime, '8') if not isinstance(postJsonObject['object'], dict): return '' @@ -1266,7 +1267,7 @@ def individualPostAsHtml(allowDownloads: bool, '">@' + actorNickname + '@' + actorDomain + '\n' # benchmark 9 - logPostTiming(enableTimingLog, postStartTime, '9') + _logPostTiming(enableTimingLog, postStartTime, '9') # Show a DM icon for DMs in the inbox timeline if showDMicon: @@ -1280,33 +1281,33 @@ def individualPostAsHtml(allowDownloads: bool, if postJsonObject['object']['commentsEnabled'] is False: commentsEnabled = False - replyStr = getReplyIconHtml(nickname, isPublicRepeat, - showIcons, commentsEnabled, - postJsonObject, pageNumberParam, - translate) + replyStr = _getReplyIconHtml(nickname, isPublicRepeat, + showIcons, commentsEnabled, + postJsonObject, pageNumberParam, + translate) - logPostTiming(enableTimingLog, postStartTime, '10') + _logPostTiming(enableTimingLog, postStartTime, '10') isEvent = isEventPost(postJsonObject) - logPostTiming(enableTimingLog, postStartTime, '11') + _logPostTiming(enableTimingLog, postStartTime, '11') - editStr = getEditIconHtml(baseDir, nickname, domainFull, - postJsonObject, actorNickname, - translate, isEvent) + editStr = _getEditIconHtml(baseDir, nickname, domainFull, + postJsonObject, actorNickname, + translate, isEvent) announceStr = \ - getAnnounceIconHtml(nickname, domainFull, - postJsonObject, - isPublicRepeat, - isModerationPost, - showRepeatIcon, - translate, - pageNumberParam, - timelinePostBookmark, - boxName) + _getAnnounceIconHtml(nickname, domainFull, + postJsonObject, + isPublicRepeat, + isModerationPost, + showRepeatIcon, + translate, + pageNumberParam, + timelinePostBookmark, + boxName) - logPostTiming(enableTimingLog, postStartTime, '12') + _logPostTiming(enableTimingLog, postStartTime, '12') # whether to show a like button hideLikeButtonFile = \ @@ -1315,81 +1316,81 @@ def individualPostAsHtml(allowDownloads: bool, if os.path.isfile(hideLikeButtonFile): showLikeButton = False - likeStr = getLikeIconHtml(nickname, domainFull, - isModerationPost, - showLikeButton, - postJsonObject, - enableTimingLog, - postStartTime, - translate, pageNumberParam, - timelinePostBookmark, - boxName) + likeStr = _getLikeIconHtml(nickname, domainFull, + isModerationPost, + showLikeButton, + postJsonObject, + enableTimingLog, + postStartTime, + translate, pageNumberParam, + timelinePostBookmark, + boxName) - logPostTiming(enableTimingLog, postStartTime, '12.5') + _logPostTiming(enableTimingLog, postStartTime, '12.5') bookmarkStr = \ - getBookmarkIconHtml(nickname, domainFull, - postJsonObject, - isModerationPost, - translate, - enableTimingLog, - postStartTime, boxName, - pageNumberParam, - timelinePostBookmark) + _getBookmarkIconHtml(nickname, domainFull, + postJsonObject, + isModerationPost, + translate, + enableTimingLog, + postStartTime, boxName, + pageNumberParam, + timelinePostBookmark) - logPostTiming(enableTimingLog, postStartTime, '12.9') + _logPostTiming(enableTimingLog, postStartTime, '12.9') isMuted = postIsMuted(baseDir, nickname, domain, postJsonObject, messageId) - logPostTiming(enableTimingLog, postStartTime, '13') + _logPostTiming(enableTimingLog, postStartTime, '13') muteStr = \ - getMuteIconHtml(isMuted, - postActor, - messageId, - nickname, domainFull, - allowDeletion, - pageNumberParam, - boxName, - timelinePostBookmark, - translate) + _getMuteIconHtml(isMuted, + postActor, + messageId, + nickname, domainFull, + allowDeletion, + pageNumberParam, + boxName, + timelinePostBookmark, + translate) deleteStr = \ - getDeleteIconHtml(nickname, domainFull, - allowDeletion, - postActor, - messageId, - postJsonObject, - pageNumberParam, - translate) + _getDeleteIconHtml(nickname, domainFull, + allowDeletion, + postActor, + messageId, + postJsonObject, + pageNumberParam, + translate) - logPostTiming(enableTimingLog, postStartTime, '13.1') + _logPostTiming(enableTimingLog, postStartTime, '13.1') # get the title: x replies to y, x announces y, etc (titleStr2, replyAvatarImageInPost, containerClassIcons, - containerClass) = getPostTitleHtml(baseDir, - httpPrefix, - nickname, domain, - showRepeatIcon, - isAnnounced, - postJsonObject, - postActor, - translate, - enableTimingLog, - postStartTime, - boxName, - personCache, - allowDownloads, - avatarPosition, - pageNumber, - messageIdStr, - containerClassIcons, - containerClass) + containerClass) = _getPostTitleHtml(baseDir, + httpPrefix, + nickname, domain, + showRepeatIcon, + isAnnounced, + postJsonObject, + postActor, + translate, + enableTimingLog, + postStartTime, + boxName, + personCache, + allowDownloads, + avatarPosition, + pageNumber, + messageIdStr, + containerClassIcons, + containerClass) titleStr += titleStr2 - logPostTiming(enableTimingLog, postStartTime, '14') + _logPostTiming(enableTimingLog, postStartTime, '14') attachmentStr, galleryStr = \ getPostAttachmentsAsHtml(postJsonObject, boxName, translate, @@ -1398,9 +1399,9 @@ def individualPostAsHtml(allowDownloads: bool, bookmarkStr, deleteStr, muteStr) publishedStr = \ - getPublishedDateStr(postJsonObject, showPublishedDateOnly) + _getPublishedDateStr(postJsonObject, showPublishedDateOnly) - logPostTiming(enableTimingLog, postStartTime, '15') + _logPostTiming(enableTimingLog, postStartTime, '15') publishedLink = messageId # blog posts should have no /statuses/ in their link @@ -1427,13 +1428,13 @@ def individualPostAsHtml(allowDownloads: bool, containerClassIcons = 'containericons dm' containerClass = 'container dm' - newFooterStr = getFooterWithIcons(showIcons, - containerClassIcons, - replyStr, announceStr, - likeStr, bookmarkStr, - deleteStr, muteStr, editStr, - postJsonObject, publishedLink, - timeClass, publishedStr) + newFooterStr = _getFooterWithIcons(showIcons, + containerClassIcons, + replyStr, announceStr, + likeStr, bookmarkStr, + deleteStr, muteStr, editStr, + postJsonObject, publishedLink, + timeClass, publishedStr) if newFooterStr: footerStr = newFooterStr @@ -1466,7 +1467,7 @@ def individualPostAsHtml(allowDownloads: bool, postJsonObject['object']['summary'], postJsonObject['object']['content']) - logPostTiming(enableTimingLog, postStartTime, '16') + _logPostTiming(enableTimingLog, postStartTime, '16') if not isPatch: objectContent = \ @@ -1509,7 +1510,7 @@ def individualPostAsHtml(allowDownloads: bool, else: contentStr += cwContentStr - logPostTiming(enableTimingLog, postStartTime, '17') + _logPostTiming(enableTimingLog, postStartTime, '17') if postJsonObject['object'].get('tag') and not isPatch: contentStr = \ @@ -1531,7 +1532,7 @@ def individualPostAsHtml(allowDownloads: bool, # show blog citations citationsStr = \ - getBlogCitationsHtml(boxName, postJsonObject, translate) + _getBlogCitationsHtml(boxName, postJsonObject, translate) postHtml = '' if boxName != 'tlmedia': @@ -1546,18 +1547,18 @@ def individualPostAsHtml(allowDownloads: bool, else: postHtml = galleryStr - logPostTiming(enableTimingLog, postStartTime, '18') + _logPostTiming(enableTimingLog, postStartTime, '18') # save the created html to the recent posts cache if not showPublicOnly and storeToCache and \ boxName != 'tlmedia' and boxName != 'tlbookmarks' and \ boxName != 'bookmarks': - saveIndividualPostAsHtmlToCache(baseDir, nickname, domain, - postJsonObject, postHtml) + _saveIndividualPostAsHtmlToCache(baseDir, nickname, domain, + postJsonObject, postHtml) updateRecentPostsCache(recentPostsCache, maxRecentPosts, postJsonObject, postHtml) - logPostTiming(enableTimingLog, postStartTime, '19') + _logPostTiming(enableTimingLog, postStartTime, '19') return postHtml diff --git a/webapp_profile.py b/webapp_profile.py index 82571a676..37957cf98 100644 --- a/webapp_profile.py +++ b/webapp_profile.py @@ -214,14 +214,14 @@ def htmlProfileAfterSearch(cssCache: {}, imageUrl = profileJson['image']['url'] profileStr = \ - getProfileHeaderAfterSearch(baseDir, - nickname, defaultTimeline, - searchNickname, - searchDomainFull, - translate, - displayName, - profileDescriptionShort, - avatarUrl, imageUrl) + _getProfileHeaderAfterSearch(baseDir, + nickname, defaultTimeline, + searchNickname, + searchDomainFull, + translate, + displayName, + profileDescriptionShort, + avatarUrl, imageUrl) domainFull = getFullDomain(domain, port) @@ -287,14 +287,14 @@ def htmlProfileAfterSearch(cssCache: {}, return htmlHeaderWithExternalStyle(cssFilename) + profileStr + htmlFooter() -def getProfileHeader(baseDir: str, nickname: str, domain: str, - domainFull: str, translate: {}, - defaultTimeline: str, - displayName: str, - avatarDescription: str, - profileDescriptionShort: str, - loginButton: str, avatarUrl: str, - theme: str) -> str: +def _getProfileHeader(baseDir: str, nickname: str, domain: str, + domainFull: str, translate: {}, + defaultTimeline: str, + displayName: str, + avatarDescription: str, + profileDescriptionShort: str, + loginButton: str, avatarUrl: str, + theme: str) -> str: """The header of the profile screen, containing background image and avatar """ @@ -327,14 +327,14 @@ def getProfileHeader(baseDir: str, nickname: str, domain: str, return htmlStr -def getProfileHeaderAfterSearch(baseDir: str, - nickname: str, defaultTimeline: str, - searchNickname: str, - searchDomainFull: str, - translate: {}, - displayName: str, - profileDescriptionShort: str, - avatarUrl: str, imageUrl: str) -> str: +def _getProfileHeaderAfterSearch(baseDir: str, + nickname: str, defaultTimeline: str, + searchNickname: str, + searchDomainFull: str, + translate: {}, + displayName: str, + profileDescriptionShort: str, + avatarUrl: str, imageUrl: str) -> str: """The header of a searched for handle, containing background image and avatar """ @@ -568,12 +568,12 @@ def htmlProfile(rssIconAtTop: bool, avatarUrl = profileJson['icon']['url'] profileHeaderStr = \ - getProfileHeader(baseDir, nickname, domain, - domainFull, translate, - defaultTimeline, displayName, - avatarDescription, - profileDescriptionShort, - loginButton, avatarUrl, theme) + _getProfileHeader(baseDir, nickname, domain, + domainFull, translate, + defaultTimeline, displayName, + avatarDescription, + profileDescriptionShort, + loginButton, avatarUrl, theme) profileStr = profileHeaderStr + donateSection profileStr += '
\n' @@ -621,44 +621,44 @@ def htmlProfile(rssIconAtTop: bool, if selected == 'posts': profileStr += \ - htmlProfilePosts(recentPostsCache, maxRecentPosts, - translate, - baseDir, httpPrefix, authorized, - nickname, domain, port, - session, wfRequest, personCache, - projectVersion, - YTReplacementDomain, - showPublishedDateOnly) + licenseStr + _htmlProfilePosts(recentPostsCache, maxRecentPosts, + translate, + baseDir, httpPrefix, authorized, + nickname, domain, port, + session, wfRequest, personCache, + projectVersion, + YTReplacementDomain, + showPublishedDateOnly) + licenseStr elif selected == 'following': profileStr += \ - htmlProfileFollowing(translate, baseDir, httpPrefix, - authorized, nickname, - domain, port, session, - wfRequest, personCache, extraJson, - projectVersion, ["unfollow"], selected, - usersPath, pageNumber, maxItemsPerPage, - dormantMonths) + _htmlProfileFollowing(translate, baseDir, httpPrefix, + authorized, nickname, + domain, port, session, + wfRequest, personCache, extraJson, + projectVersion, ["unfollow"], selected, + usersPath, pageNumber, maxItemsPerPage, + dormantMonths) elif selected == 'followers': profileStr += \ - htmlProfileFollowing(translate, baseDir, httpPrefix, - authorized, nickname, - domain, port, session, - wfRequest, personCache, extraJson, - projectVersion, ["block"], - selected, usersPath, pageNumber, - maxItemsPerPage, dormantMonths) + _htmlProfileFollowing(translate, baseDir, httpPrefix, + authorized, nickname, + domain, port, session, + wfRequest, personCache, extraJson, + projectVersion, ["block"], + selected, usersPath, pageNumber, + maxItemsPerPage, dormantMonths) elif selected == 'roles': profileStr += \ - htmlProfileRoles(translate, nickname, domainFull, - extraJson) + _htmlProfileRoles(translate, nickname, domainFull, + extraJson) elif selected == 'skills': profileStr += \ - htmlProfileSkills(translate, nickname, domainFull, extraJson) + _htmlProfileSkills(translate, nickname, domainFull, extraJson) elif selected == 'shares': profileStr += \ - htmlProfileShares(actor, translate, - nickname, domainFull, - extraJson) + licenseStr + _htmlProfileShares(actor, translate, + nickname, domainFull, + extraJson) + licenseStr profileStr = \ htmlHeaderWithExternalStyle(cssFilename) + \ @@ -666,15 +666,15 @@ def htmlProfile(rssIconAtTop: bool, return profileStr -def htmlProfilePosts(recentPostsCache: {}, maxRecentPosts: int, - translate: {}, - baseDir: str, httpPrefix: str, - authorized: bool, - nickname: str, domain: str, port: int, - session, wfRequest: {}, personCache: {}, - projectVersion: str, - YTReplacementDomain: str, - showPublishedDateOnly: bool) -> str: +def _htmlProfilePosts(recentPostsCache: {}, maxRecentPosts: int, + translate: {}, + baseDir: str, httpPrefix: str, + authorized: bool, + nickname: str, domain: str, port: int, + session, wfRequest: {}, personCache: {}, + projectVersion: str, + YTReplacementDomain: str, + showPublishedDateOnly: bool) -> str: """Shows posts on the profile screen These should only be public posts """ @@ -720,16 +720,16 @@ def htmlProfilePosts(recentPostsCache: {}, maxRecentPosts: int, return profileStr -def htmlProfileFollowing(translate: {}, baseDir: str, httpPrefix: str, - authorized: bool, - nickname: str, domain: str, port: int, - session, wfRequest: {}, personCache: {}, - followingJson: {}, projectVersion: str, - buttons: [], - feedName: str, actor: str, - pageNumber: int, - maxItemsPerPage: int, - dormantMonths: int) -> str: +def _htmlProfileFollowing(translate: {}, baseDir: str, httpPrefix: str, + authorized: bool, + nickname: str, domain: str, port: int, + session, wfRequest: {}, personCache: {}, + followingJson: {}, projectVersion: str, + buttons: [], + feedName: str, actor: str, + pageNumber: int, + maxItemsPerPage: int, + dormantMonths: int) -> str: """Shows following on the profile screen """ profileStr = '' @@ -756,12 +756,12 @@ def htmlProfileFollowing(translate: {}, baseDir: str, httpPrefix: str, dormantMonths) profileStr += \ - individualFollowAsHtml(translate, baseDir, session, - wfRequest, personCache, - domain, followingActor, - authorized, nickname, - httpPrefix, projectVersion, dormant, - buttons) + _individualFollowAsHtml(translate, baseDir, session, + wfRequest, personCache, + domain, followingActor, + authorized, nickname, + httpPrefix, projectVersion, dormant, + buttons) if authorized and maxItemsPerPage and pageNumber: if len(followingJson['orderedItems']) >= maxItemsPerPage: @@ -778,8 +778,8 @@ def htmlProfileFollowing(translate: {}, baseDir: str, httpPrefix: str, return profileStr -def htmlProfileRoles(translate: {}, nickname: str, domain: str, - rolesJson: {}) -> str: +def _htmlProfileRoles(translate: {}, nickname: str, domain: str, + rolesJson: {}) -> str: """Shows roles on the profile screen """ profileStr = '' @@ -801,8 +801,8 @@ def htmlProfileRoles(translate: {}, nickname: str, domain: str, return profileStr -def htmlProfileSkills(translate: {}, nickname: str, domain: str, - skillsJson: {}) -> str: +def _htmlProfileSkills(translate: {}, nickname: str, domain: str, + skillsJson: {}) -> str: """Shows skills on the profile screen """ profileStr = '' @@ -817,8 +817,8 @@ def htmlProfileSkills(translate: {}, nickname: str, domain: str, return profileStr -def htmlProfileShares(actor: str, translate: {}, - nickname: str, domain: str, sharesJson: {}) -> str: +def _htmlProfileShares(actor: str, translate: {}, + nickname: str, domain: str, sharesJson: {}) -> str: """Shows shares on the profile screen """ profileStr = '' @@ -1450,16 +1450,16 @@ def htmlEditProfile(cssCache: {}, translate: {}, baseDir: str, path: str, return editProfileForm -def individualFollowAsHtml(translate: {}, - baseDir: str, session, wfRequest: {}, - personCache: {}, domain: str, - followUrl: str, - authorized: bool, - actorNickname: str, - httpPrefix: str, - projectVersion: str, - dormant: bool, - buttons=[]) -> str: +def _individualFollowAsHtml(translate: {}, + baseDir: str, session, wfRequest: {}, + personCache: {}, domain: str, + followUrl: str, + authorized: bool, + actorNickname: str, + httpPrefix: str, + projectVersion: str, + dormant: bool, + buttons=[]) -> str: """An individual follow entry on the profile screen """ nickname = getNicknameFromActor(followUrl) diff --git a/webapp_timeline.py b/webapp_timeline.py index 70e0d237a..0cb01c850 100644 --- a/webapp_timeline.py +++ b/webapp_timeline.py @@ -27,8 +27,8 @@ from webapp_headerbuttons import headerButtonsTimeline from posts import isModerator -def logTimelineTiming(enableTimingLog: bool, timelineStartTime, - boxName: str, debugId: str) -> None: +def _logTimelineTiming(enableTimingLog: bool, timelineStartTime, + boxName: str, debugId: str) -> None: """Create a log of timings for performance tuning """ if not enableTimingLog: @@ -127,7 +127,7 @@ def htmlTimeline(cssCache: {}, defaultTimeline: str, bannerFile, bannerFilename = \ getBannerFile(baseDir, nickname, domain, theme) - logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '1') + _logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '1') # is the user a moderator? if not moderator: @@ -137,7 +137,7 @@ def htmlTimeline(cssCache: {}, defaultTimeline: str, if not editor: editor = isEditor(baseDir, nickname) - logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '2') + _logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '2') # the appearance of buttons - highlighted or not inboxButton = 'button' @@ -221,7 +221,7 @@ def htmlTimeline(cssCache: {}, defaultTimeline: str, '" src="/icons/person.png"/>\n' break - logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '3') + _logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '3') # moderation / reports button moderationButtonStr = '' @@ -256,7 +256,7 @@ def htmlTimeline(cssCache: {}, defaultTimeline: str, tlStr = htmlHeaderWithExternalStyle(cssFilename) - logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '4') + _logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '4') # if this is a news instance and we are viewing the news timeline newsHeader = False @@ -487,17 +487,17 @@ def htmlTimeline(cssCache: {}, defaultTimeline: str, tlStr += '
\n\n' - logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '6') + _logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '6') if boxName == 'tlshares': maxSharesPerAccount = itemsPerPage return (tlStr + - htmlSharesTimeline(translate, pageNumber, itemsPerPage, - baseDir, actor, nickname, domain, port, - maxSharesPerAccount, httpPrefix) + + _htmlSharesTimeline(translate, pageNumber, itemsPerPage, + baseDir, actor, nickname, domain, port, + maxSharesPerAccount, httpPrefix) + htmlFooter()) - logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '7') + _logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '7') # page up arrow if pageNumber > 1: @@ -543,14 +543,14 @@ def htmlTimeline(cssCache: {}, defaultTimeline: str, preparePostFromHtmlCache(currTlStr, boxName, pageNumber) - logTimelineTiming(enableTimingLog, - timelineStartTime, - boxName, '10') + _logTimelineTiming(enableTimingLog, + timelineStartTime, + boxName, '10') if not currTlStr: - logTimelineTiming(enableTimingLog, - timelineStartTime, - boxName, '11') + _logTimelineTiming(enableTimingLog, + timelineStartTime, + boxName, '11') # read the post from disk currTlStr = \ @@ -570,8 +570,8 @@ def htmlTimeline(cssCache: {}, defaultTimeline: str, showIndividualPostIcons, manuallyApproveFollowers, False, True) - logTimelineTiming(enableTimingLog, - timelineStartTime, boxName, '12') + _logTimelineTiming(enableTimingLog, + timelineStartTime, boxName, '12') if currTlStr: itemCtr += 1 @@ -612,7 +612,7 @@ def htmlTimeline(cssCache: {}, defaultTimeline: str, rightColumnStr + ' \n' tlStr += ' \n' - logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '9') + _logTimelineTiming(enableTimingLog, timelineStartTime, boxName, '9') tlStr += ' \n' tlStr += '\n' @@ -656,10 +656,10 @@ def htmlIndividualShare(actor: str, item: {}, translate: {}, return profileStr -def htmlSharesTimeline(translate: {}, pageNumber: int, itemsPerPage: int, - baseDir: str, actor: str, - nickname: str, domain: str, port: int, - maxSharesPerAccount: int, httpPrefix: str) -> str: +def _htmlSharesTimeline(translate: {}, pageNumber: int, itemsPerPage: int, + baseDir: str, actor: str, + nickname: str, domain: str, port: int, + maxSharesPerAccount: int, httpPrefix: str) -> str: """Show shared items timeline as html """ sharesJson, lastPage = \ diff --git a/webapp_utils.py b/webapp_utils.py index baa2cb0cd..67947e644 100644 --- a/webapp_utils.py +++ b/webapp_utils.py @@ -167,7 +167,7 @@ def getContentWarningButton(postID: str, translate: {}, '\n' -def getActorPropertyUrl(actorJson: {}, propertyName: str) -> str: +def _getActorPropertyUrl(actorJson: {}, propertyName: str) -> str: """Returns a url property from an actor """ if not actorJson.get('attachment'): @@ -206,10 +206,10 @@ def getActorPropertyUrl(actorJson: {}, propertyName: str) -> str: def getBlogAddress(actorJson: {}) -> str: """Returns blog address for the given actor """ - return getActorPropertyUrl(actorJson, 'Blog') + return _getActorPropertyUrl(actorJson, 'Blog') -def setActorPropertyUrl(actorJson: {}, propertyName: str, url: str) -> None: +def _setActorPropertyUrl(actorJson: {}, propertyName: str, url: str) -> None: """Sets a url for the given actor property """ if not actorJson.get('attachment'): @@ -269,7 +269,7 @@ def setActorPropertyUrl(actorJson: {}, propertyName: str, url: str) -> None: def setBlogAddress(actorJson: {}, blogAddress: str) -> None: """Sets an blog address for the given actor """ - setActorPropertyUrl(actorJson, 'Blog', removeHtml(blogAddress)) + _setActorPropertyUrl(actorJson, 'Blog', removeHtml(blogAddress)) def updateAvatarImageCache(session, baseDir: str, httpPrefix: str, @@ -475,8 +475,8 @@ def postContainsPublic(postJsonObject: {}) -> bool: return containsPublic -def getImageFile(baseDir: str, name: str, directory: str, - nickname: str, domain: str, theme: str) -> (str, str): +def _getImageFile(baseDir: str, name: str, directory: str, + nickname: str, domain: str, theme: str) -> (str, str): """ returns the filenames for an image with the given name """ @@ -495,30 +495,30 @@ def getImageFile(baseDir: str, name: str, directory: str, def getBannerFile(baseDir: str, nickname: str, domain: str, theme: str) -> (str, str): - return getImageFile(baseDir, 'banner', - baseDir + '/accounts/' + nickname + '@' + domain, - nickname, domain, theme) + return _getImageFile(baseDir, 'banner', + baseDir + '/accounts/' + nickname + '@' + domain, + nickname, domain, theme) def getSearchBannerFile(baseDir: str, nickname: str, domain: str, theme: str) -> (str, str): - return getImageFile(baseDir, 'search_banner', - baseDir + '/accounts/' + nickname + '@' + domain, - nickname, domain, theme) + return _getImageFile(baseDir, 'search_banner', + baseDir + '/accounts/' + nickname + '@' + domain, + nickname, domain, theme) def getLeftImageFile(baseDir: str, nickname: str, domain: str, theme: str) -> (str, str): - return getImageFile(baseDir, 'left_col_image', - baseDir + '/accounts/' + nickname + '@' + domain, - nickname, domain, theme) + return _getImageFile(baseDir, 'left_col_image', + baseDir + '/accounts/' + nickname + '@' + domain, + nickname, domain, theme) def getRightImageFile(baseDir: str, nickname: str, domain: str, theme: str) -> (str, str): - return getImageFile(baseDir, 'right_col_image', - baseDir + '/accounts/' + nickname + '@' + domain, - nickname, domain, theme) + return _getImageFile(baseDir, 'right_col_image', + baseDir + '/accounts/' + nickname + '@' + domain, + nickname, domain, theme) def htmlHeaderWithExternalStyle(cssFilename: str, lang='en') -> str: diff --git a/webfinger.py b/webfinger.py index 8b64e17c2..fe31f6909 100644 --- a/webfinger.py +++ b/webfinger.py @@ -25,7 +25,7 @@ from utils import saveJson from utils import getProtocolPrefixes -def parseHandle(handle: str) -> (str, str): +def _parseHandle(handle: str) -> (str, str): if '.' not in handle: return None, None prefixes = getProtocolPrefixes() @@ -54,7 +54,7 @@ def webfingerHandle(session, handle: str, httpPrefix: str, print('WARN: No session specified for webfingerHandle') return None - nickname, domain = parseHandle(handle) + nickname, domain = _parseHandle(handle) if not nickname: return None wfDomain = domain @@ -97,7 +97,7 @@ def webfingerHandle(session, handle: str, httpPrefix: str, return result -def generateMagicKey(publicKeyPem) -> str: +def _generateMagicKey(publicKeyPem) -> str: """See magic_key method in https://github.com/tootsuite/mastodon/blob/ 707ddf7808f90e3ab042d7642d368c2ce8e95e6f/app/models/account.rb @@ -170,7 +170,7 @@ def createWebfingerEndpoint(nickname: str, domain: str, port: int, "type": "application/activity+json" }, { - "href": generateMagicKey(publicKeyPem), + "href": _generateMagicKey(publicKeyPem), "rel": "magic-public-key" } ], @@ -271,7 +271,7 @@ def webfingerLookup(path: str, baseDir: str, return wfJson -def webfingerUpdateFromProfile(wfJson: {}, actorJson: {}) -> bool: +def _webfingerUpdateFromProfile(wfJson: {}, actorJson: {}) -> bool: """Updates webfinger Email/blog/xmpp links from profile Returns true if one or more tags has been changed """ @@ -350,6 +350,6 @@ def webfingerUpdate(baseDir: str, nickname: str, domain: str, if not actorJson: return - if webfingerUpdateFromProfile(wfJson, actorJson): + if _webfingerUpdateFromProfile(wfJson, actorJson): if saveJson(wfJson, filename): cachedWebfingers[handle] = wfJson From 2fd901d682dd8e828188dc38752e42c08660e8cd Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 18:16:24 +0000 Subject: [PATCH 08/17] Check that public functions don't begin with _ --- tests.py | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/tests.py b/tests.py index 945032a6f..3c2942165 100644 --- a/tests.py +++ b/tests.py @@ -2626,6 +2626,7 @@ def testFunctions(): for name, properties in functionProperties.items(): if name in exclusions: continue + isLocalModule = False if not properties['calledInModule']: print('function ' + name + ' in module ' + properties['module'] + @@ -2636,9 +2637,10 @@ def testFunctions(): modName = properties['calledInModule'][0] if modName not in excludeLocal and \ modName == properties['module']: + isLocalModule = True if not name.startswith('_'): print('Local function ' + name + - ' in ' + modName + ' does not begin with _') + ' in ' + modName + '.py does not begin with _') assert False if name not in excludeImports: @@ -2649,6 +2651,19 @@ def testFunctions(): if importStr not in open(modName + '.py').read(): print(importStr + ' not found in ' + modName + '.py') assert False + + if not isLocalModule: + if name.startswith('_'): + excludePublic = [ + 'pyjsonld', + 'daemon', + 'tests' + ] + modName = properties['module'] + if modName not in excludePublic: + print('Public function ' + name + ' in ' + + modName + '.py begins with _') + assert False print('Function: ' + name + ' ✓') From ce885947ca938eed20dee50bb2c5d17674099da6 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 18:20:32 +0000 Subject: [PATCH 09/17] Variable name --- tests.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests.py b/tests.py index 3c2942165..893bdacdb 100644 --- a/tests.py +++ b/tests.py @@ -2626,7 +2626,7 @@ def testFunctions(): for name, properties in functionProperties.items(): if name in exclusions: continue - isLocalModule = False + isLocalFunction = False if not properties['calledInModule']: print('function ' + name + ' in module ' + properties['module'] + @@ -2637,7 +2637,7 @@ def testFunctions(): modName = properties['calledInModule'][0] if modName not in excludeLocal and \ modName == properties['module']: - isLocalModule = True + isLocalFunction = True if not name.startswith('_'): print('Local function ' + name + ' in ' + modName + '.py does not begin with _') @@ -2652,7 +2652,7 @@ def testFunctions(): print(importStr + ' not found in ' + modName + '.py') assert False - if not isLocalModule: + if not isLocalFunction: if name.startswith('_'): excludePublic = [ 'pyjsonld', From 152d6228c7a63438e40f19bd969a5e3a45763bc1 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 19:28:34 +0000 Subject: [PATCH 10/17] Tidying --- tests.py | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/tests.py b/tests.py index 893bdacdb..bf5ac6932 100644 --- a/tests.py +++ b/tests.py @@ -2537,19 +2537,23 @@ def testFunctions(): print('testFunctions') function = {} functionProperties = {} - modules = [] + modules = {} for subdir, dirs, files in os.walk('.'): for sourceFile in files: if not sourceFile.endswith('.py'): continue modName = sourceFile.replace('.py', '') - modules.append(modName) + modules[modName] = { + 'functions': [] + } sourceStr = '' with open(sourceFile, "r") as f: sourceStr = f.read() + modules[modName]['source'] = sourceStr with open(sourceFile, "r") as f: lines = f.readlines() + modules[modName]['lines'] = lines for line in lines: if not line.startswith('def '): continue @@ -2562,6 +2566,8 @@ def testFunctions(): function[modName].append(methodName) else: function[modName] = [methodName] + if methodName not in modules[modName]['functions']: + modules[modName]['functions'].append(methodName) functionProperties[methodName] = { "args": methodArgs, "module": modName, @@ -2570,19 +2576,17 @@ def testFunctions(): break # which modules is each function used within? - for modName in modules: + for modName, modProperties in modules.items(): print('Module: ' + modName + ' ✓') - with open(modName + '.py', "r") as f: - lines = f.readlines() - for name, properties in functionProperties.items(): - for line in lines: - if line.startswith('def '): - continue - if name + '(' in line: - modList = \ - functionProperties[name]['calledInModule'] - if modName not in modList: - modList.append(modName) + for name, properties in functionProperties.items(): + for line in modules[modName]['lines']: + if line.startswith('def '): + continue + if name + '(' in line: + modList = \ + functionProperties[name]['calledInModule'] + if modName not in modList: + modList.append(modName) # don't check these functions, because they are procedurally called exclusions = [ @@ -2648,7 +2652,7 @@ def testFunctions(): if modName == properties['module']: continue importStr = 'from ' + properties['module'] + ' import ' + name - if importStr not in open(modName + '.py').read(): + if importStr not in modules[modName]['source']: print(importStr + ' not found in ' + modName + '.py') assert False @@ -2670,6 +2674,7 @@ def testFunctions(): def runAllTests(): print('Running tests...') testFunctions() + return testReplyToPublicPost() testGetMentionedPeople() testGuessHashtagCategory() From 49e052d5f02f2f876cc2386c6d7b053e36eaa169 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 19:29:14 +0000 Subject: [PATCH 11/17] Tidying --- tests.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tests.py b/tests.py index bf5ac6932..738e396b7 100644 --- a/tests.py +++ b/tests.py @@ -2674,7 +2674,6 @@ def testFunctions(): def runAllTests(): print('Running tests...') testFunctions() - return testReplyToPublicPost() testGetMentionedPeople() testGuessHashtagCategory() From 3ff0866deb3d4a3d8ee28c94dbefec2f2579437c Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 21:24:46 +0000 Subject: [PATCH 12/17] Test that number of function arguments match --- blurhash.py | 3 +- daemon.py | 44 ++++++++---- epicyon.py | 79 +++++++++++++++++---- inbox.py | 28 +++++--- newswire.py | 3 +- person.py | 4 +- posts.py | 3 +- schedule.py | 4 +- tests.py | 161 +++++++++++++++++++++++++++++++++++++----- theme.py | 2 +- utils.py | 3 +- webapp_frontscreen.py | 6 +- webapp_moderation.py | 3 +- webapp_post.py | 2 +- webapp_profile.py | 6 +- 15 files changed, 282 insertions(+), 69 deletions(-) diff --git a/blurhash.py b/blurhash.py index 7728c8399..de2eb50ea 100644 --- a/blurhash.py +++ b/blurhash.py @@ -174,7 +174,8 @@ def blurhash_encode(image, components_x=4, components_y=4, linear=False): # Build final blurhash blurhash = "" - blurhash += _base83_encode((components_x - 1) + (components_y - 1) * 9, 1) + blurhashValue = (components_x - 1) + (components_y - 1) * 9 + blurhash += _base83_encode(blurhashValue, 1) blurhash += _base83_encode(quant_max_ac_component, 1) blurhash += _base83_encode(dc_value, 4) for ac_value in ac_values: diff --git a/daemon.py b/daemon.py index d89edd841..8537ea5b5 100644 --- a/daemon.py +++ b/daemon.py @@ -58,7 +58,7 @@ from person import personBoxJson from person import createSharedInbox from person import createNewsInbox from person import suspendAccount -from person import unsuspendAccount +from person import reenableAccount from person import removeAccount from person import canRemovePost from person import personSnooze @@ -1074,13 +1074,14 @@ class PubServer(BaseHTTPRequestHandler): beginSaveTime = time.time() # save the json for later queue processing + messageBytesDecoded = messageBytes.decode('utf-8') queueFilename = \ savePostToInboxQueue(self.server.baseDir, self.server.httpPrefix, nickname, self.server.domainFull, messageJson, - messageBytes.decode('utf-8'), + messageBytesDecoded, headersDict, self.path, self.server.debug) @@ -1514,7 +1515,7 @@ class PubServer(BaseHTTPRequestHandler): if moderationButton == 'suspend': suspendAccount(baseDir, nickname, domain) if moderationButton == 'unsuspend': - unsuspendAccount(baseDir, nickname) + reenableAccount(baseDir, nickname) if moderationButton == 'filter': addGlobalFilter(baseDir, moderationText) if moderationButton == 'unfilter': @@ -2912,11 +2913,13 @@ class PubServer(BaseHTTPRequestHandler): if self.postToNickname: if monthStr and yearStr: if monthStr.isdigit() and yearStr.isdigit(): + yearInt = int(yearStr) + monthInt = int(monthStr) removeCalendarEvent(baseDir, self.postToNickname, domain, - int(yearStr), - int(monthStr), + yearInt, + monthInt, removeMessageId) self._postToOutboxThread(deleteJson) if callingDomain.endswith('.onion') and onionDomain: @@ -6837,6 +6840,7 @@ class PubServer(BaseHTTPRequestHandler): recentPostsCache, maxRecentPosts, translate, + self.server.baseDir, self.server.session, cachedWebfingers, personCache, @@ -7062,6 +7066,7 @@ class PubServer(BaseHTTPRequestHandler): 'show inbox page') fullWidthTimelineButtonHeader = \ self.server.fullWidthTimelineButtonHeader + minimalNick = self._isMinimal(nickname) msg = htmlInbox(self.server.cssCache, defaultTimeline, recentPostsCache, @@ -7079,7 +7084,7 @@ class PubServer(BaseHTTPRequestHandler): allowDeletion, httpPrefix, projectVersion, - self._isMinimal(nickname), + minimalNick, YTReplacementDomain, self.server.showPublishedDateOnly, self.server.newswire, @@ -7185,6 +7190,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.votingTimeMins) fullWidthTimelineButtonHeader = \ self.server.fullWidthTimelineButtonHeader + minimalNick = self._isMinimal(nickname) msg = \ htmlInboxDMs(self.server.cssCache, self.server.defaultTimeline, @@ -7203,7 +7209,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.allowDeletion, httpPrefix, self.server.projectVersion, - self._isMinimal(nickname), + minimalNick, self.server.YTReplacementDomain, self.server.showPublishedDateOnly, self.server.newswire, @@ -7301,6 +7307,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.votingTimeMins) fullWidthTimelineButtonHeader = \ self.server.fullWidthTimelineButtonHeader + minimalNick = self._isMinimal(nickname) msg = \ htmlInboxReplies(self.server.cssCache, self.server.defaultTimeline, @@ -7319,7 +7326,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.allowDeletion, httpPrefix, self.server.projectVersion, - self._isMinimal(nickname), + minimalNick, self.server.YTReplacementDomain, self.server.showPublishedDateOnly, self.server.newswire, @@ -7417,6 +7424,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.votingTimeMins) fullWidthTimelineButtonHeader = \ self.server.fullWidthTimelineButtonHeader + minimalNick = self._isMinimal(nickname) msg = \ htmlInboxMedia(self.server.cssCache, self.server.defaultTimeline, @@ -7435,7 +7443,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.allowDeletion, httpPrefix, self.server.projectVersion, - self._isMinimal(nickname), + minimalNick, self.server.YTReplacementDomain, self.server.showPublishedDateOnly, self.server.newswire, @@ -7534,6 +7542,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.votingTimeMins) fullWidthTimelineButtonHeader = \ self.server.fullWidthTimelineButtonHeader + minimalNick = self._isMinimal(nickname) msg = \ htmlInboxBlogs(self.server.cssCache, self.server.defaultTimeline, @@ -7552,7 +7561,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.allowDeletion, httpPrefix, self.server.projectVersion, - self._isMinimal(nickname), + minimalNick, self.server.YTReplacementDomain, self.server.showPublishedDateOnly, self.server.newswire, @@ -7659,6 +7668,7 @@ class PubServer(BaseHTTPRequestHandler): editor = isEditor(baseDir, currNickname) fullWidthTimelineButtonHeader = \ self.server.fullWidthTimelineButtonHeader + minimalNick = self._isMinimal(nickname) msg = \ htmlInboxNews(self.server.cssCache, self.server.defaultTimeline, @@ -7677,7 +7687,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.allowDeletion, httpPrefix, self.server.projectVersion, - self._isMinimal(nickname), + minimalNick, self.server.YTReplacementDomain, self.server.showPublishedDateOnly, self.server.newswire, @@ -7782,6 +7792,7 @@ class PubServer(BaseHTTPRequestHandler): currNickname = currNickname.split('/')[0] fullWidthTimelineButtonHeader = \ self.server.fullWidthTimelineButtonHeader + minimalNick = self._isMinimal(nickname) msg = \ htmlInboxFeatures(self.server.cssCache, self.server.defaultTimeline, @@ -7800,7 +7811,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.allowDeletion, httpPrefix, self.server.projectVersion, - self._isMinimal(nickname), + minimalNick, self.server.YTReplacementDomain, self.server.showPublishedDateOnly, self.server.newswire, @@ -7967,6 +7978,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.votingTimeMins) fullWidthTimelineButtonHeader = \ self.server.fullWidthTimelineButtonHeader + minimalNick = self._isMinimal(nickname) msg = \ htmlBookmarks(self.server.cssCache, self.server.defaultTimeline, @@ -7985,7 +7997,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.allowDeletion, httpPrefix, self.server.projectVersion, - self._isMinimal(nickname), + minimalNick, self.server.YTReplacementDomain, self.server.showPublishedDateOnly, self.server.newswire, @@ -8087,6 +8099,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.votingTimeMins) fullWidthTimelineButtonHeader = \ self.server.fullWidthTimelineButtonHeader + minimalNick = self._isMinimal(nickname) msg = \ htmlEvents(self.server.cssCache, self.server.defaultTimeline, @@ -8105,7 +8118,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.allowDeletion, httpPrefix, self.server.projectVersion, - self._isMinimal(nickname), + minimalNick, self.server.YTReplacementDomain, self.server.showPublishedDateOnly, self.server.newswire, @@ -8199,6 +8212,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.votingTimeMins) fullWidthTimelineButtonHeader = \ self.server.fullWidthTimelineButtonHeader + minimalNick = self._isMinimal(nickname) msg = \ htmlOutbox(self.server.cssCache, self.server.defaultTimeline, @@ -8217,7 +8231,7 @@ class PubServer(BaseHTTPRequestHandler): self.server.allowDeletion, httpPrefix, self.server.projectVersion, - self._isMinimal(nickname), + minimalNick, self.server.YTReplacementDomain, self.server.showPublishedDateOnly, self.server.newswire, diff --git a/epicyon.py b/epicyon.py index 8b243c66e..4e0de4b2c 100644 --- a/epicyon.py +++ b/epicyon.py @@ -1124,7 +1124,7 @@ if args.undoItemName: cachedWebfingers = {} print('Sending undo of shared item: ' + args.undoItemName) - sendUndoShareViaServer(session, + sendUndoShareViaServer(baseDir, session, args.nickname, args.password, domain, port, httpPrefix, @@ -1931,33 +1931,88 @@ if args.testdata: deleteAllPosts(baseDir, nickname, domain, 'inbox') deleteAllPosts(baseDir, nickname, domain, 'outbox') + + testFollowersOnly = False + testSaveToFile = True + testClientToServer = False + testCommentsEnabled = True + testAttachImageFilename = None + testMediaType = None + testImageDescription = None + createPublicPost(baseDir, nickname, domain, port, httpPrefix, - "like, this is totally just a #test, man", - False, True, False, True, None, None, useBlurhash) + "like this is totally just a #test man", + testFollowersOnly, + testSaveToFile, + testClientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, testImageDescription, + useBlurhash) createPublicPost(baseDir, nickname, domain, port, httpPrefix, "Zoiks!!!", - False, True, False, True, None, None, useBlurhash) + testFollowersOnly, + testSaveToFile, + testClientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, testImageDescription, + useBlurhash) createPublicPost(baseDir, nickname, domain, port, httpPrefix, "Hey scoob we need like a hundred more #milkshakes", - False, True, False, True, None, None, useBlurhash) + testFollowersOnly, + testSaveToFile, + testClientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, testImageDescription, + useBlurhash) createPublicPost(baseDir, nickname, domain, port, httpPrefix, "Getting kinda spooky around here", - False, True, False, True, None, None, + testFollowersOnly, + testSaveToFile, + testClientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, testImageDescription, useBlurhash, 'someone') createPublicPost(baseDir, nickname, domain, port, httpPrefix, "And they would have gotten away with it too" + "if it wasn't for those pesky hackers", - False, True, False, True, 'img/logo.png', - 'Description of image', useBlurhash) + testFollowersOnly, + testSaveToFile, + testClientToServer, + testCommentsEnabled, + 'img/logo.png', 'image/png', + 'Description of image', + useBlurhash) createPublicPost(baseDir, nickname, domain, port, httpPrefix, - "man, these centralized sites are, like, the worst!", - False, True, False, True, None, None, useBlurhash) + "man these centralized sites are like the worst!", + testFollowersOnly, + testSaveToFile, + testClientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, testImageDescription, + useBlurhash) createPublicPost(baseDir, nickname, domain, port, httpPrefix, "another mystery solved #test", - False, True, False, True, None, None, useBlurhash) + testFollowersOnly, + testSaveToFile, + testClientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, testImageDescription, + useBlurhash) createPublicPost(baseDir, nickname, domain, port, httpPrefix, "let's go bowling", - False, True, False, True, None, None, useBlurhash) + testFollowersOnly, + testSaveToFile, + testClientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, testImageDescription, + useBlurhash) domainFull = domain + ':' + str(port) clearFollows(baseDir, nickname, domain) diff --git a/inbox.py b/inbox.py index 70073d718..680132308 100644 --- a/inbox.py +++ b/inbox.py @@ -959,8 +959,9 @@ def _receiveLike(recentPostsCache: {}, if not os.path.isdir(baseDir + '/accounts/' + handle): print('DEBUG: unknown recipient of like - ' + handle) # if this post in the outbox of the person? - postFilename = locatePost(baseDir, handle.split('@')[0], - handle.split('@')[1], + handleName = handle.split('@')[0] + handleDom = handle.split('@')[1] + postFilename = locatePost(baseDir, handleName, handleDom, messageJson['object']) if not postFilename: if debug: @@ -970,9 +971,10 @@ def _receiveLike(recentPostsCache: {}, if debug: print('DEBUG: liked post found in inbox') + handleName = handle.split('@')[0] + handleDom = handle.split('@')[1] if not _alreadyLiked(baseDir, - handle.split('@')[0], - handle.split('@')[1], + handleName, handleDom, messageJson['object'], messageJson['actor']): updateLikesCollection(recentPostsCache, baseDir, postFilename, @@ -1028,8 +1030,10 @@ def _receiveUndoLike(recentPostsCache: {}, if not os.path.isdir(baseDir + '/accounts/' + handle): print('DEBUG: unknown recipient of undo like - ' + handle) # if this post in the outbox of the person? + handleName = handle.split('@')[0] + handleDom = handle.split('@')[1] postFilename = \ - locatePost(baseDir, handle.split('@')[0], handle.split('@')[1], + locatePost(baseDir, handleName, handleDom, messageJson['object']['object']) if not postFilename: if debug: @@ -1446,8 +1450,9 @@ def _receiveUndoAnnounce(recentPostsCache: {}, if not os.path.isdir(baseDir + '/accounts/' + handle): print('DEBUG: unknown recipient of undo announce - ' + handle) # if this post in the outbox of the person? - postFilename = locatePost(baseDir, handle.split('@')[0], - handle.split('@')[1], + handleName = handle.split('@')[0] + handleDom = handle.split('@')[1] + postFilename = locatePost(baseDir, handleName, handleDom, messageJson['object']['object']) if not postFilename: if debug: @@ -2361,13 +2366,14 @@ def _inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, print('Saving inbox post as html to cache') htmlCacheStartTime = time.time() + handleName = handle.split('@')[0] _inboxStorePostToHtmlCache(recentPostsCache, maxRecentPosts, translate, baseDir, httpPrefix, session, cachedWebfingers, personCache, - handle.split('@')[0], + handleName, domain, port, postJsonObject, allowDeletion, @@ -2383,7 +2389,8 @@ def _inboxAfterInitial(recentPostsCache: {}, maxRecentPosts: int, _inboxUpdateCalendar(baseDir, handle, postJsonObject) - storeHashTags(baseDir, handle.split('@')[0], postJsonObject) + handleName = handle.split('@')[0] + storeHashTags(baseDir, handleName, postJsonObject) # send the post out to group members if isGroup: @@ -2710,12 +2717,13 @@ def runInboxQueue(recentPostsCache: {}, maxRecentPosts: int, if debug: print('DEBUG: checking http headers') pprint(queueJson['httpHeaders']) + postStr = json.dumps(queueJson['post']) if not verifyPostHeaders(httpPrefix, pubKey, queueJson['httpHeaders'], queueJson['path'], False, queueJson['digest'], - json.dumps(queueJson['post']), + postStr, debug): print('Queue: Header signature check failed') pprint(queueJson['httpHeaders']) diff --git a/newswire.py b/newswire.py index 657641c47..ae4b8d21e 100644 --- a/newswire.py +++ b/newswire.py @@ -813,13 +813,14 @@ def _addAccountBlogsToNewswire(baseDir: str, nickname: str, domain: str, content = postJsonObject['object']['content'] description = firstParagraphFromString(content) description = _removeCDATA(description) + tagsFromPost = _getHashtagsFromPost(postJsonObject) _addNewswireDictEntry(baseDir, domain, newswire, published, postJsonObject['object']['summary'], postJsonObject['object']['url'], votes, fullPostFilename, description, moderated, False, - _getHashtagsFromPost(postJsonObject), + tagsFromPost, maxTags) ctr += 1 diff --git a/person.py b/person.py index a2b76bd2d..b7e80061a 100644 --- a/person.py +++ b/person.py @@ -758,7 +758,7 @@ def setBio(baseDir: str, nickname: str, domain: str, bio: str) -> bool: return True -def unsuspendAccount(baseDir: str, nickname: str) -> None: +def reenableAccount(baseDir: str, nickname: str) -> None: """Removes an account suspention """ suspendedFilename = baseDir + '/accounts/suspended.txt' @@ -897,7 +897,7 @@ def removeAccount(baseDir: str, nickname: str, if moderator.strip('\n') == nickname: return False - unsuspendAccount(baseDir, nickname) + reenableAccount(baseDir, nickname) handle = nickname + '@' + domain removePassword(baseDir, nickname) _removeTagsForNickname(baseDir, nickname, domain, port) diff --git a/posts.py b/posts.py index 1bb3462a6..895c50c7e 100644 --- a/posts.py +++ b/posts.py @@ -1936,8 +1936,9 @@ def sendPostViaServer(projectVersion: str, 'Content-type': 'application/json', 'Authorization': authHeader } + postDumps = json.dumps(postJsonObject) postResult = \ - postJsonString(session, json.dumps(postJsonObject), [], + postJsonString(session, postDumps, [], inboxUrl, headers, debug) if not postResult: if debug: diff --git a/schedule.py b/schedule.py index 0cf8797ca..6d781b375 100644 --- a/schedule.py +++ b/schedule.py @@ -104,7 +104,9 @@ def _updatePostSchedule(baseDir: str, handle: str, httpd, httpd.proxyType, httpd.projectVersion, httpd.debug, - httpd.YTReplacementDomain): + httpd.YTReplacementDomain, + httpd.showPublishedDateOnly, + httpd.allowLocalNetworkAccess): indexLines.remove(line) os.remove(postFilename) continue diff --git a/tests.py b/tests.py index 738e396b7..e90f6796f 100644 --- a/tests.py +++ b/tests.py @@ -274,19 +274,44 @@ def createServerAlice(path: str, domain: str, port: int, followerOfPerson(path, nickname, domain, 'bob', bobAddress, federationList, False) if hasPosts: - clientToServer = False + testFollowersOnly = False + testSaveToFile = True + clientToServer = False + testCommentsEnabled = True + testAttachImageFilename = None + testMediaType = None + testImageDescription = None createPublicPost(path, nickname, domain, port, httpPrefix, "No wise fish would go anywhere without a porpoise", - False, True, clientToServer, True, - None, None, useBlurhash) + testFollowersOnly, + testSaveToFile, + clientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, + testImageDescription, + useBlurhash) createPublicPost(path, nickname, domain, port, httpPrefix, - "Curiouser and curiouser!", False, True, - clientToServer, True, None, None, useBlurhash) + "Curiouser and curiouser!", + testFollowersOnly, + testSaveToFile, + clientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, + testImageDescription, + useBlurhash) createPublicPost(path, nickname, domain, port, httpPrefix, "In the gardens of memory, in the palace " + "of dreams, that is where you and I shall meet", - False, True, clientToServer, True, - None, None, useBlurhash) + testFollowersOnly, + testSaveToFile, + clientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, + testImageDescription, + useBlurhash) global testServerAliceRunning testServerAliceRunning = True maxMentions = 10 @@ -346,19 +371,42 @@ def createServerBob(path: str, domain: str, port: int, followerOfPerson(path, nickname, domain, 'alice', aliceAddress, federationList, False) if hasPosts: + testFollowersOnly = False + testSaveToFile = True + testCommentsEnabled = True + testAttachImageFilename = None + testMediaType = None createPublicPost(path, nickname, domain, port, httpPrefix, "It's your life, live it your way.", - False, True, clientToServer, True, - None, None, useBlurhash) + testFollowersOnly, + testSaveToFile, + clientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, + testImageDescription, + useBlurhash) createPublicPost(path, nickname, domain, port, httpPrefix, "One of the things I've realised is that " + "I am very simple", - False, True, clientToServer, True, - None, None, useBlurhash) + testFollowersOnly, + testSaveToFile, + clientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, + testImageDescription, + useBlurhash) createPublicPost(path, nickname, domain, port, httpPrefix, "Quantum physics is a bit of a passion of mine", - False, True, clientToServer, True, - None, None, useBlurhash) + testFollowersOnly, + testSaveToFile, + clientToServer, + testCommentsEnabled, + testAttachImageFilename, + testMediaType, + testImageDescription, + useBlurhash) global testServerBobRunning testServerBobRunning = True maxMentions = 10 @@ -601,10 +649,12 @@ def testPostMessageBetweenServers(): print('\n\n*******************************************************') print("Bob likes Alice's post") + aliceDomainStr = aliceDomain + ':' + str(alicePort) followerOfPerson(bobDir, 'bob', bobDomain, 'alice', - aliceDomain + ':' + str(alicePort), federationList, False) + aliceDomainStr, federationList, False) + bobDomainStr = bobDomain + ':' + str(bobPort) followPerson(aliceDir, 'alice', aliceDomain, 'bob', - bobDomain + ':' + str(bobPort), federationList, False) + bobDomainStr, federationList, False) sessionBob = createSession(proxyType) bobPostLog = [] @@ -1753,7 +1803,8 @@ def testWebLinks(): 'they prefer to cling to their customs, beliefs, and traditions ' + \ 'rather than to accept the teachings of a war of each ' + \ 'against all"\n\n--Peter Kropotkin' - resultText = removeLongWords(addWebLinks(exampleText), 40, []) + testFnStr = addWebLinks(exampleText) + resultText = removeLongWords(testFnStr, 40, []) assert resultText == exampleText assert 'ellipsis' not in resultText @@ -1767,7 +1818,8 @@ def testWebLinks(): exampleText = \ '

Test1 test2 #YetAnotherExcessivelyLongwindedAndBoringHashtag

' - resultText = removeLongWords(addWebLinks(exampleText), 40, []) + testFnStr = addWebLinks(exampleText) + resultText = removeLongWords(testFnStr, 40, []) assert(resultText == '

Test1 test2 ' '#YetAnotherExcessivelyLongwindedAndBorin\ngHashtag

') @@ -1776,7 +1828,8 @@ def testWebLinks(): "

Don't remove a p2p link " + \ "rad:git:hwd1yrerc3mcgn8ga9rho3dqi4w33nep7kxmqezss4topyfgmexihp" + \ "33xcw

" - resultText = removeLongWords(addWebLinks(exampleText), 40, []) + testFnStr = addWebLinks(exampleText) + resultText = removeLongWords(testFnStr, 40, []) assert resultText == exampleText @@ -2533,6 +2586,48 @@ def testReplyToPublicPost() -> None: httpPrefix + '://rat.site/users/ninjarodent' +def getFunctionCallArgs(name: str, lines: [], startLineCtr: int) -> []: + """Returns the arguments of a function call given lines + of source code and a starting line number + """ + argsStr = lines[startLineCtr].split(name + '(')[1] + if ')' in argsStr: + argsStr = argsStr.split(')')[0].replace(' ', '').split(',') + return argsStr + for lineCtr in range(startLineCtr + 1, len(lines)): + if ')' not in lines[lineCtr]: + argsStr += lines[lineCtr] + continue + else: + argsStr += lines[lineCtr].split(')')[0] + break + return argsStr.replace('\n', '').replace(' ', '').split(',') + + +def functionArgsMatch(callArgs: [], funcArgs: []): + """Do the function artuments match the function call arguments + """ + if len(callArgs) == len(funcArgs): + return True + + # count non-optional arguments + callArgsCtr = 0 + for a in callArgs: + if a == 'self': + continue + if '=' not in a: + callArgsCtr += 1 + + funcArgsCtr = 0 + for a in funcArgs: + if a == 'self': + continue + if '=' not in a: + funcArgsCtr += 1 + + return callArgsCtr >= funcArgsCtr + + def testFunctions(): print('testFunctions') function = {} @@ -2575,18 +2670,48 @@ def testFunctions(): } break + excludeFuncArgs = [ + 'pyjsonld' + ] + excludeFuncs = [ + 'link' + ] # which modules is each function used within? for modName, modProperties in modules.items(): print('Module: ' + modName + ' ✓') for name, properties in functionProperties.items(): + lineCtr = 0 for line in modules[modName]['lines']: if line.startswith('def '): + lineCtr += 1 continue if name + '(' in line: modList = \ functionProperties[name]['calledInModule'] if modName not in modList: modList.append(modName) + if modName in excludeFuncArgs: + lineCtr += 1 + continue + if name in excludeFuncs: + lineCtr += 1 + continue + callArgs = \ + getFunctionCallArgs(name, + modules[modName]['lines'], + lineCtr) + if not functionArgsMatch(callArgs, + functionProperties[name]['args']): + print('Call to function ' + name + + ' does not match its arguments') + print('def args: ' + + str(len(functionProperties[name]['args'])) + + '\n' + str(functionProperties[name]['args'])) + print('Call args: ' + str(len(callArgs)) + '\n' + + str(callArgs)) + print('module ' + modName + ' line ' + str(lineCtr)) + assert False + lineCtr += 1 # don't check these functions, because they are procedurally called exclusions = [ diff --git a/theme.py b/theme.py index 14515f6ac..df7f4c80a 100644 --- a/theme.py +++ b/theme.py @@ -579,7 +579,7 @@ def setTheme(baseDir: str, name: str, domain: str, if not result: # default - _setThemeDefault(baseDir) + _setThemeDefault(baseDir, allowLocalNetworkAccess) result = True variablesFile = baseDir + '/theme/' + name + '/theme.json' diff --git a/utils.py b/utils.py index 2468e5a51..ff89afd02 100644 --- a/utils.py +++ b/utils.py @@ -647,7 +647,8 @@ def followPerson(baseDir: str, nickname: str, domain: str, followFile='following.txt') -> bool: """Adds a person to the follow list """ - if not domainPermitted(followDomain.lower().replace('\n', ''), + followDomainStrLower = followDomain.lower().replace('\n', '') + if not domainPermitted(followDomainStrLower, federationList): if debug: print('DEBUG: follow of domain ' + diff --git a/webapp_frontscreen.py b/webapp_frontscreen.py index 1e289f4a8..ab667ed80 100644 --- a/webapp_frontscreen.py +++ b/webapp_frontscreen.py @@ -40,10 +40,12 @@ def _htmlFrontScreenPosts(recentPostsCache: {}, maxRecentPosts: int, boxName = 'tlfeatures' authorized = True while ctr < maxItems and currPage < 4: + outboxFeedPathStr = \ + '/users/' + nickname + '/' + boxName + \ + '?page=' + str(currPage) outboxFeed = \ personBoxJson({}, session, baseDir, domain, port, - '/users/' + nickname + '/' + boxName + - '?page=' + str(currPage), + outboxFeedPathStr, httpPrefix, 10, boxName, authorized, 0, False, 0) if not outboxFeed: diff --git a/webapp_moderation.py b/webapp_moderation.py index 6dad2b3a4..fabb0b895 100644 --- a/webapp_moderation.py +++ b/webapp_moderation.py @@ -110,8 +110,9 @@ def htmlAccountInfo(cssCache: {}, translate: {}, urlCtr += 1 blockedPostsHtml = '' if blockedPostsLinks: + blockNoStr = 'blockNumber' + str(ctr) blockedPostsHtml = \ - getContentWarningButton('blockNumber' + str(ctr), + getContentWarningButton(blockNoStr, translate, blockedPostsLinks) ctr += 1 diff --git a/webapp_post.py b/webapp_post.py index 412d7b78d..274a7840c 100644 --- a/webapp_post.py +++ b/webapp_post.py @@ -772,7 +772,7 @@ def _getPostTitleAnnounceHtml(baseDir: str, containerClassIcons, containerClass) -def _replyToYourselfHtml(translate: {}, ) -> str: +def _replyToYourselfHtml(translate: {}) -> str: """Returns html for a title which is a reply to yourself """ return ' None: def getFunctionCallArgs(name: str, lines: [], startLineCtr: int) -> []: """Returns the arguments of a function call given lines of source code and a starting line number - """ + """ argsStr = lines[startLineCtr].split(name + '(')[1] if ')' in argsStr: argsStr = argsStr.split(')')[0].replace(' ', '').split(',') From b42964ff59e02259a461457f937bf662aa9cd141 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 22:55:45 +0000 Subject: [PATCH 14/17] Save call graph as dot diagram --- tests.py | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/tests.py b/tests.py index eb7f78786..1b6f9e54b 100644 --- a/tests.py +++ b/tests.py @@ -2605,6 +2605,25 @@ def getFunctionCallArgs(name: str, lines: [], startLineCtr: int) -> []: return argsStr.replace('\n', '').replace(' ', '').split(',') +def getFunctionCalls(name: str, lines: [], startLineCtr: int, + functionProperties: {}) -> []: + """Returns the functions called by the given one, + Starting with the given source code at the given line + """ + callsFunctions = [] + functionContentStr = '' + for lineCtr in range(startLineCtr + 1, len(lines)): + if lines[lineCtr].startswith('def '): + break + if lines[lineCtr].startswith('class '): + break + functionContentStr += lines[lineCtr] + for funcName, properties in functionProperties.items(): + if funcName + '(' in functionContentStr: + callsFunctions.append(funcName) + return callsFunctions + + def functionArgsMatch(callArgs: [], funcArgs: []): """Do the function artuments match the function call arguments """ @@ -2796,6 +2815,43 @@ def testFunctions(): assert False print('Function: ' + name + ' ✓') + print('Constructing call graph') + for modName, modProperties in modules.items(): + lineCtr = 0 + for line in modules[modName]['lines']: + if line.startswith('def '): + name = line.split('def ')[1].split('(')[0] + callsList = \ + getFunctionCalls(name, modules[modName]['lines'], + lineCtr, functionProperties) + functionProperties[name]['calls'] = callsList.copy() + lineCtr += 1 + callGraphStr = 'digraph Epicyon {\n\n' + callGraphStr += ' graph [fontsize=10 fontname="Verdana" compound=true];\n' + callGraphStr += ' node [shape=record fontsize=10 fontname="Verdana"];\n\n' + + for modName, modProperties in modules.items(): + callGraphStr += ' subgraph ' + modName + ' {\n' + callGraphStr += ' node [style=filled];\n' + callGraphStr += ' ' + for name in modProperties['functions']: + callGraphStr += '"' + name + '" ' + callGraphStr += ';\n' + callGraphStr += ' label = "' + modName + '";\n' + callGraphStr += ' color=blue;\n' + callGraphStr += ' }\n\n' + + for name, properties in functionProperties.items(): + if not properties['calls']: + continue + for calledFunc in properties['calls']: + callGraphStr += ' "' + name + '" -> "' + calledFunc + '";\n' + + callGraphStr += '\n}\n' + with open('epicyon.dot', 'w+') as fp: + fp.write(callGraphStr) + print('Call graph saved to epicyon.dot') + def runAllTests(): print('Running tests...') From b927863f7e9dfb7fb3984dcc968d1966005e5ee4 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 23:04:17 +0000 Subject: [PATCH 15/17] Instructions for converting to image --- tests.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests.py b/tests.py index 1b6f9e54b..57527e549 100644 --- a/tests.py +++ b/tests.py @@ -2851,6 +2851,8 @@ def testFunctions(): with open('epicyon.dot', 'w+') as fp: fp.write(callGraphStr) print('Call graph saved to epicyon.dot') + print('Convert to image with: ' + + 'dot -T epicyon.dot -o epicyon_diagram.jpg') def runAllTests(): From 82a7cb2cb2d6ddd6d921dcdd648e72dc766386dd Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 23:09:09 +0000 Subject: [PATCH 16/17] Image format --- tests.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests.py b/tests.py index 57527e549..d637642b4 100644 --- a/tests.py +++ b/tests.py @@ -2844,15 +2844,15 @@ def testFunctions(): for name, properties in functionProperties.items(): if not properties['calls']: continue - for calledFunc in properties['calls']: - callGraphStr += ' "' + name + '" -> "' + calledFunc + '";\n' + # for calledFunc in properties['calls']: + # callGraphStr += ' "' + name + '" -> "' + calledFunc + '";\n' callGraphStr += '\n}\n' with open('epicyon.dot', 'w+') as fp: fp.write(callGraphStr) print('Call graph saved to epicyon.dot') print('Convert to image with: ' + - 'dot -T epicyon.dot -o epicyon_diagram.jpg') + 'dot -Tjpg epicyon.dot -o epicyon_diagram.jpg') def runAllTests(): From 61280ac6d03e905a8c81a6eb64d8a1d6c894be3f Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 22 Dec 2020 23:26:09 +0000 Subject: [PATCH 17/17] Clustering of dot diagram --- tests.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tests.py b/tests.py index d637642b4..5bd93560e 100644 --- a/tests.py +++ b/tests.py @@ -2831,21 +2831,21 @@ def testFunctions(): callGraphStr += ' node [shape=record fontsize=10 fontname="Verdana"];\n\n' for modName, modProperties in modules.items(): - callGraphStr += ' subgraph ' + modName + ' {\n' + callGraphStr += ' subgraph cluster_' + modName + ' {\n' + callGraphStr += ' label = "' + modName + '";\n' callGraphStr += ' node [style=filled];\n' callGraphStr += ' ' for name in modProperties['functions']: callGraphStr += '"' + name + '" ' callGraphStr += ';\n' - callGraphStr += ' label = "' + modName + '";\n' callGraphStr += ' color=blue;\n' callGraphStr += ' }\n\n' for name, properties in functionProperties.items(): if not properties['calls']: continue - # for calledFunc in properties['calls']: - # callGraphStr += ' "' + name + '" -> "' + calledFunc + '";\n' + for calledFunc in properties['calls']: + callGraphStr += ' "' + name + '" -> "' + calledFunc + '";\n' callGraphStr += '\n}\n' with open('epicyon.dot', 'w+') as fp: