-
-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add MyWatchlistGenerator #102
Merged
CXuesong
merged 2 commits into
CXuesong:master
from
ashotjanibekyan:feature/MyWatchlistGenerator
Aug 30, 2023
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
using System.Collections.Generic; | ||
using WikiClientLibrary.Generators.Primitive; | ||
using WikiClientLibrary.Infrastructures; | ||
using WikiClientLibrary.Sites; | ||
|
||
namespace WikiClientLibrary.Generators | ||
{ | ||
/// <summary> | ||
/// Get all pages on the current user's watchlist. | ||
/// </summary> | ||
public class MyWatchlistGenerator : WikiPageGenerator | ||
{ | ||
public MyWatchlistGenerator(WikiSite site) : base(site) | ||
{ | ||
} | ||
|
||
/// <summary> | ||
/// Only list pages in the given namespaces. | ||
/// </summary> | ||
public IEnumerable<int>? NamespaceIds { get; set; } | ||
|
||
/// <summary> | ||
/// Adds timestamp of when the user was last notified about the edit. | ||
/// </summary> | ||
public bool ShowChangedTime { get; set; } | ||
|
||
/// <summary> | ||
/// Only show pages that have not been changed. | ||
/// </summary> | ||
public PropertyFilterOption NotChangedPagesFilter { get; set; } | ||
|
||
/// <summary> | ||
/// Gets/sets a value that indicates whether the links should be listed in | ||
/// the descending order. (MediaWiki 1.19+) | ||
/// </summary> | ||
public bool OrderDescending { get; set; } | ||
|
||
/// <summary> | ||
/// Title (with namespace prefix) to begin enumerating from. | ||
/// </summary> | ||
public string? FromTitle { get; set; } | ||
|
||
/// <summary> | ||
/// Title (with namespace prefix) to stop enumerating at. | ||
/// </summary> | ||
public string? ToTitle { get; set; } | ||
|
||
public override IEnumerable<KeyValuePair<string, object?>> EnumListParameters() | ||
{ | ||
return new Dictionary<string, object?> | ||
{ | ||
{"wrnamespace", NamespaceIds == null ? null : MediaWikiHelper.JoinValues(NamespaceIds)}, | ||
{"wrlimit", PaginationSize}, | ||
{"wrprop", ShowChangedTime ? "changed" : null}, | ||
{"wrshow", NotChangedPagesFilter.ToString("!changed", "changed", null)}, | ||
{"wrdir", OrderDescending ? "descending" : "ascending"}, | ||
{"wrfromtitle", FromTitle}, | ||
{"wrtotitle", ToTitle}, | ||
}; | ||
} | ||
|
||
public override string ListName => "watchlistraw"; | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ShowChangedTime
(and remove theShowChangedTime
property), if you need it. I guess it does not increase much sever cost.ChangedTime
), you may want to set up a wiki list item type (likeGeoSearchResultItem
) and override theWikiPageGenerator<TItem>.ItemFromJson
method, so thatWikiPageGenerator<TItem>.EnumItemsAsync
can enumerate something containing aPageStub
and aChangedTime
, rather thanPageStub
only. You can refer toGeoSearchGenerator
as an example. (Or you can just leave this work to me 😂)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@CXuesong. {{Done}} :)
I don't like that I hardcoded the value in FindQueryResponseItemsRoot but I couldn't find other lists that give results in a different format (I tested on Armenian Wikipedia).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
I guess this is the first time I discover a query result without
query
JSON root node. Yeah probably we can go without any generic root-finding-function for now, and see what happens.