simplepie/simplepie-ng

Don't use this yet.

---

SimplePie NG

Don't use this yet. Yes, this project is still active… just as I have time.

SimplePie NG is a modern, next-generation PHP package for working with syndication feeds. It has been written from the ground-up to take advantage of the modern features of PHP 7.3+.

It starts with a completely different kind of thinking, and more than 15 years of experience in software engineering and open-source. It is written with a view of PHP from today and beyond, and is being built in such a way that greater community involvement should be far easier from much earlier in the project's life.

See the Documentation or the API Reference.

Badges

Health

Quality

Social

Compliance

Coding Standards

PSR-1/2/5/12/19 are a solid foundation, but are not an entire coding style by themselves. We automate a large part of our style requirements using PHP CS Fixer and PHP CodeSniffer. (The things that we cannot yet automate are documented in the SimplePie NG Coding Standards.)

These can be applied/fixed automatically by running the (lightweight) linter:

make lint

Additionally, in our quest to write excellent code, we use a variety of tools to help us catch issues with what we've written, including:

Type	Description
Linting Tools	PHP CS Fixer, PHP CodeSniffer
QA Tools	PDepend, PHPLOC, PHP Copy/Paste Detector, PHP Code Analyzer
Static Analysis	Phan, PHPStan, Psalm, PHP Dependency Analysis

These reports can be generated by running the (heavyweight) analyzer:

make analyze

Please Support or Sponsor Development

The SimplePie project is a labor of love. Development of the next-generation of SimplePie was started in June 2017 as because it's a project I love, and I believe our community would benefit from this tool.

If you use SimplePie — especially to make money — it would be swell if you could kick down a few bucks. As the project grows, and we start leveraging more services and architecture, it would be great if it didn't all need to come out of my pocket.

You can also sponsor the development of a particular feature. If there's a feature that you want to see implemented, and I believe it's the right fit for the SimplePie project, you can sponsor the development of the feature to get it prioritized.

Your contributions are greatly and sincerely appreciated. See the Sponsor button along the top of the page for more information.

simplepie-ng's Issues

Clarify shared hosting providers non-support

Quoting the readme:

Will almost certainly not work with shared hosting providers. Time to get a grown-up server.

Since this is supposed to be just a PHP library, why would that not work on shared hosting providers?

The support for shared hosting providers is still important because, for example, for students, especially in less wealthy countries, shared hosting might be the only way to afford a “private cloud”. I was also relying on that until very recently. And even if one has the money, running a server takes significantly more effort.

Also, the ability to deploy applications to a shared hosting is the only reason why I still use PHP at all – on my own server I can just use the better languages.

Add support for <atom:source> under <atom:entry>.

The assignment to $path is dead and can be removed.

see https://scrutinizer-ci.com/g/simplepie/simplepie-ng/inspections/70f0de72-0b3c-406a-a9ff-c3e667ffaa0a/issues/files/src/Middleware/Xml/Atom.php?status=new&orderField=path&order=asc&honorSelectedPaths=0&issueId=26691108#inspectioncomment-95741651

Pull HTML5 entities from W3C

Parse this and turn it into the DTD format we need. https://www.w3.org/TR/html5/entities.json

Opt-in validation of data types

Can help people ensure valid creation of feeds, but has extra processing cost. Make it opt-in since it's not strictly required.

• LanguageTag
• MediaType
• Uri
• etc.

https://github.com/simplepie/simplepie-ng/wiki/Spec%3A-Atom-1.0#appendix-b-relax-ng-compact-schema

incompatible with the declared type SimplePie\Mixin\stdClass of property $root.

see https://scrutinizer-ci.com/g/simplepie/simplepie-ng/inspections/70f0de72-0b3c-406a-a9ff-c3e667ffaa0a/issues/files/src/Type/Feed.php?status=new&orderField=path&order=asc&honorSelectedPaths=0&issueId=26691114#inspectioncomment-95741657

Document the license, why I chose it, and what it means for users

The property namespaceAlias does not exist on SimplePie\Mixin\DeepTypeTrait.

see https://scrutinizer-ci.com/g/simplepie/simplepie-ng/inspections/70f0de72-0b3c-406a-a9ff-c3e667ffaa0a/issues/files/src/Mixin/DeepTypeTrait.php?status=new&orderField=path&order=asc&honorSelectedPaths=0&issueId=26691113#inspectioncomment-95741656

W3C Annotation Schema

• https://www.w3.org/2000/10/annotation-ns

Creative Commons RSS Module

• http://backend.userland.com/creativeCommonsRssModule

W3C WGS84 Geo

• https://www.w3.org/2003/01/geo/

iTunes Podcast RSS

• https://help.apple.com/itc/podcasts_connect/#/itcb54353390

[Insight] Commented code should not be committed - in src/Type/Entry.php, line 54

in src/Type/Entry.php, line 54

Commented out code reduces readability and lowers the code confidence for other developers. If it's common usage for debug, it should not be committed. Using a version control system, such code can be safely removed.

        if ($node) {
            $this->logger = $logger ?? new NullLogger();
            $this->node   = $node;

            // foreach ($this->node->attributes as $attribute) {
            //     $this->{$attribute->name} = new Node($attribute);
            // }
        }
    }

    /**

---

Posted from SensioLabsInsight

The property name does not exist.

see https://scrutinizer-ci.com/g/simplepie/simplepie-ng/issues/master/files/src/Type/Link.php?orderField=path&order=asc&fileId=src%2FType%2FNode.php&honorSelectedPaths=0&issueId=26310873#inspectioncomment-95703819

Feature Request: For non-standard input dates, allow users to teach SimplePie how to parse them.

See simplepie/simplepie#475 for context.

RSS 2.0 support

• http://www.rssboard.org/rss-specification

The property domDocument does not exist.

see https://scrutinizer-ci.com/g/simplepie/simplepie-ng/issues/master/files/src/Util/Ns.php?orderField=path&order=asc&honorSelectedPaths=0&issueId=22951309#inspectioncomment-95663033

Investigate C++ encoding detection

https://github.com/google/compact_enc_det

Support namespace URLs by regex

This will be a cleaner way of handling small variations of the namespace URL (e.g., https, trailing slashes).

GeoRSS (Simple)

• http://www.georss.org/simple.html

GeoRSS (GML)

• http://www.georss.org/gml.html

JSON Feed v1

• https://jsonfeed.org/version/1

The type SimplePie\Mixin\stdClass was not found.

see https://scrutinizer-ci.com/g/simplepie/simplepie-ng/inspections/70f0de72-0b3c-406a-a9ff-c3e667ffaa0a/issues/files/src/Mixin/RootTrait.php?status=new&orderField=path&order=asc&honorSelectedPaths=0&issueId=26691115#inspectioncomment-95741658

Review HTML 5 parser

• https://github.com/Masterminds/html5-php/wiki/Basic-Usage

Compat: missing_quote_in_attr

Should we leave bunk HTML alone? Or pass it through an HTML5 parser?

FeedParser.py passes it through an HTML5 parser.

W3C Simple Knowledge Organization System (SKOS)

• https://www.w3.org/2009/08/skos-reference/skos.html

Ensure all Atom elements support `base` and `lang`

https://github.com/simplepie/simplepie-ng/wiki/Spec%3A-Atom-1.0#2-atom-documents

atomCommonAttributes =
    attribute xml:base { atomUri }?,
    attribute xml:lang { atomLanguageTag }?,
    undefinedAttribute*

Add support for converting to UTF-8

Add the ability to detect and convert a variety of character encodings to UTF-8 for parsing.

Document fundamental info for users and contributors

Node::$base should be a string.

see https://scrutinizer-ci.com/g/simplepie/simplepie-ng/inspections/436032b4-6c13-472e-b9d5-1b510fe9838b/issues/files/src/Type/Node.php?status=new&orderField=path&order=asc&honorSelectedPaths=0&issueId=27643076#inspectioncomment-97939801

Modeling `Type\Author` for h-feed.

this looks awesome @skyzyx! Glad you've got the time to take this on.

Just wanted to mention an issue I've had when retrofitting microformats into SimplePie OG (yes I think I will use that term...) The issue is that h-entry's have a wider vocabulary for authors via h-card than traditional feeds. So instead of just being a name or email address they can be full html markup with profile images, urls, etc. This makes it hard to be an afterthought because you've probably made a few assumptions about content types for author before implementing it.

Anyway feel free to close this issue.

Atom 1.0 support

• https://tools.ietf.org/html/rfc4287
• https://www.w3.org/wiki/Atom

RSS 1.0 support

• http://web.resource.org/rss/1.0/spec

Solidify the Middleware workflow and interfaces

Media RSS

• http://www.rssboard.org/media-rss

FOAF

• http://xmlns.com/foaf/spec/

The property length does not seem to exist on DOMNamedNodeMap.

see https://scrutinizer-ci.com/g/simplepie/simplepie-ng/issues/master/files/src/Type/Node.php?orderField=path&order=asc&honorSelectedPaths=0&issueId=26310598#inspectioncomment-95703818

Pull recognized <link rel> values from IANA

https://www.iana.org/assignments/link-relations/link-relations.xml

[Insight] Object parameters should be type hinted - in src/Type/Feed.php, line 184

in src/Type/Feed.php, line 184

The parameter link, which is an object, should be typehinted.

                $links = $this->getComplexMultipleValues($this->getRoot(), $nodeName, $args[0] ?? null);

                if (isset($args[1])) {
                    $relFilter = $args[1];

                    return \array_values(\array_filter($links, static function ($link) use ($relFilter) {
                        return $relFilter === $link->getRel()->getValue();
                    }));
                }

                return $links;

---

Posted from SensioLabsInsight

Node::$lang should be a string.

see https://scrutinizer-ci.com/g/simplepie/simplepie-ng/inspections/436032b4-6c13-472e-b9d5-1b510fe9838b/issues/files/src/Type/Node.php?status=new&orderField=path&order=asc&honorSelectedPaths=0&issueId=27643077#inspectioncomment-97939802

Dublin Core Terms

• http://dublincore.org/documents/2012/06/14/dcmi-terms/

RSS 1.0 Content Modules

• http://web.resource.org/rss/1.0/modules/content/

[Insight] Object parameters should be type hinted - in src/Type/Entry.php, line 193

in src/Type/Entry.php, line 193

The parameter link, which is an object, should be typehinted.

                $links = $this->getComplexMultipleValues($this, $nodeName, $args[0]);

                if (isset($args[1])) {
                    $relFilter = $args[1];

                    return \array_values(\array_filter($links, static function ($link) use ($relFilter) {
                        return $relFilter === $link->getRel()->getValue();
                    }));
                }

                return $links;

---

Posted from SensioLabsInsight

Review URL resolution in content

• https://github.com/thephpleague/uri

If media type value is missing, use a lookup table for commonly-known media types

Document XPath stuff

https://www.w3.org/TR/xpath/#location-paths

Investigate opt-in sanitization of content

• https://github.com/ezyang/htmlpurifier
• http://htmlpurifier.org/docs/
• http://htmlpurifier.org/live/configdoc/plain.html
• https://github.com/Masterminds/html5-php/wiki/Basic-Usage

The variable $nodes does not seem to be defined for all execution paths leading up to this point.

see https://scrutinizer-ci.com/g/simplepie/simplepie-ng/inspections/70f0de72-0b3c-406a-a9ff-c3e667ffaa0a/issues/files/src/Middleware/Xml/Atom.php?status=new&orderField=path&order=asc&honorSelectedPaths=0&issueId=26691107#inspectioncomment-95741650

Dublin Core Metadata 1.0

• http://dublincore.org/documents/1998/09/dces/

Document support for case-insensitive XPath queries